Struct kubernix::Config

pub struct Config { /* fields omitted */ }

The global configuration

Implementations

impl Config

pub fn log_level(&self) -> LevelFilter

The logging level of the application

pub fn cidr(&self) -> Ipv4Network

The CIDR used for the cluster

pub fn nodes(&self) -> u8

The number of nodes to be registered

impl Config

pub fn subcommand(&self) -> &Option<SubCommand>

All available subcommands

pub fn root(&self) -> &PathBuf

Path where all the runtime data is stored

pub fn overlay(&self) -> &Option<PathBuf>

The Nix package overlay to be used

pub fn packages(&self) -> &Vec<String>

Additional dependencies to be added to the environment

pub fn shell(&self) -> &Option<String>

The shell executable to be used, defaults to $SHELL, fallback is sh

pub fn container_runtime(&self) -> &String

The container runtime to be used for the nodes, irrelevant if nodes equals to 1

pub fn no_shell(&self) -> &bool

Do not spawn an interactive shell after bootstrap

impl Config

pub fn canonicalize_root(&mut self) -> Result<()>

Make the configs root path absolute

pub fn to_file(&self) -> Result<()>

Write the current configuration to the internal set root path

pub fn try_load_file(&mut self) -> Result<()>

Read the configuration from the internal set root path If not existing, write the current configuration to the path.

pub fn shell_ok(&self) -> Result<String>

Return the set shell as result type

pub fn multi_node(&self) -> bool

Returns true if multi node support is enabled

Trait Implementations

impl Clap for Config

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I) where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error> where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Update from iterator, return Err on error.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Config

fn from_arg_matches(arg_matches: &ArgMatches) -> Self

It’s common to have an “application context” struct (sometimes called config) that represents all the normalized values after being processed by the CLI.

fn update_from_arg_matches(&mut self, arg_matches: &ArgMatches)

@TODO@ @release @docs

impl IntoApp for Config

fn into_app<'b>() -> App<'b>

@TODO @release @docs

fn into_app_for_update<'b>() -> App<'b>

@TODO @release @docs

fn augment_clap<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs

fn augment_clap_for_update<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.