Struct tari_common::configuration::bootstrap::ConfigBootstrap

pub struct ConfigBootstrap {
    pub base_path: PathBuf,
    pub config: PathBuf,
    pub log_config: PathBuf,
    pub init: bool,
    pub create_id: bool,
    pub daemon_mode: bool,
    pub rebuild_db: bool,
    pub input_file: Option<PathBuf>,
    pub command: Option<String>,
    pub clean_orphans_db: bool,
    pub enable_mining: bool,
    pub password: Option<String>,
    pub change_password: bool,
    pub recovery: bool,
}

Fields

base_path: PathBuf

A path to a directory to store your files

config: PathBuf

A path to the configuration file to use (config.toml)

log_config: PathBuf

The path to the log configuration file. It is set using the following precedence set

init: bool

Create a default configuration file if it doesn't exist

create_id: bool

Create and save new node identity if one doesn't exist

daemon_mode: bool

Run in daemon mode, with no interface

rebuild_db: bool

This will rebuild the db, adding block for block in

input_file: Option<PathBuf>

Path to input file of commands

command: Option<String>

Single input command

clean_orphans_db: bool

This will clean out the orphans db at startup

enable_mining: bool

Enable Mining

password: Option<String>

Supply the password for the console wallet

change_password: bool

Change the password for the console wallet

recovery: bool

Force wallet recovery

Implementations

impl ConfigBootstrap

pub fn init_dirs(
    &mut self,
    application_type: ApplicationType
) -> Result<(), ConfigError>

Initialize configuration and directories based on ConfigBootstrap options.

If not present it will create base directory (default ~/.tari/, depending on OS). Log and tari configs will be initialized in the base directory too.

Without --init flag provided configuration and directories will be created only after user's confirmation.

pub fn initialize_logging(&self) -> Result<(), ConfigError>

Set up application-level logging using the Log4rs configuration file based on supplied CLI arguments

pub fn load_configuration(&self) -> Result<Config, ConfigError>

Load configuration from files located based on supplied CLI arguments

Trait Implementations

impl Debug for ConfigBootstrap

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConfigBootstrap

fn default() -> Self

Returns the "default value" for a type.

impl StructOpt for ConfigBootstrap

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It's guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for ConfigBootstrap

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

fn is_subcommand() -> bool

pub fn from_subcommand(
    _sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>