Struct sn_node::Config

pub struct Config {
    pub wallet_id: Option<String>,
    pub max_capacity: Option<u64>,
    pub root_dir: Option<PathBuf>,
    pub verbose: u64,
    pub local: bool,
    pub first: bool,
    pub network_config: NetworkConfig,
    pub completions: Option<String>,
    pub log_dir: Option<PathBuf>,
    pub update: bool,
    pub update_only: bool,
    pub clear_data: bool,
}

Node configuration

Fields

wallet_id: Option<String>

The address to be credited when this node farms SafeCoin. A hex formatted BLS public key.

max_capacity: Option<u64>

Upper limit in bytes for allowed network storage on this node.

root_dir: Option<PathBuf>

Root directory for ChunkStores and cached state. If not set, it defaults to "root_dir" within the sn_node project data directory, located at: Linux: $HOME/.safe/node/root_dir Windows: {FOLDERID_Profile}/.safe/node/root_dir MacOS: $HOME/.safe/node/root_dir

verbose: u64

Verbose output. -v is equivalent to logging with warn, -vv to info, -vvv to debug, -vvvv to trace. This flag overrides RUST_LOG.

local: bool

Is the node running for a local section?

first: bool

Is this the first node in a section?

network_config: NetworkConfig

completions: Option<String>

dump shell completions for: [bash, fish, zsh, powershell, elvish]

log_dir: Option<PathBuf>

Send logs to a file within the specified directory

update: bool

Attempt to self-update?

update_only: bool

Attempt to self-update without starting the node process

clear_data: bool

Delete all data from a previous node running on the same PC

Implementations

impl Config

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

Returns a new Config instance. Tries to read from the default node config file location, and overrides values with any equivalent command line args.

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

The address to be credited when this node farms SafeCoin.

pub fn is_first(&self) -> bool

Is this the first node in a section?

pub fn is_local(&self) -> bool

Is the node running for a local section?

pub fn max_capacity(&self) -> u64

Upper limit in bytes for allowed network storage on this node.

pub fn root_dir(&self) -> Result<PathBuf>

Root directory for ChunkStores and cached state. If not set, it defaults to DEFAULT_ROOT_DIR_NAME within the project's data directory (see Config::root_dir for the directories on each platform).

pub fn set_root_dir<P: Into<PathBuf>>(&mut self, path: P)

Set the root directory for ChunkStores and cached state.

pub fn set_log_dir<P: Into<PathBuf>>(&mut self, path: P)

Set the directory to write the logs.

pub fn verbose(&self) -> Level

Get the log level.

pub fn network_config(&self) -> &NetworkConfig

Network configuration options.

pub fn set_network_config(&mut self, config: NetworkConfig)

Set network configuration options.

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

Get the completions option

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

Directory where to write log file/s if specified

pub fn update(&self) -> bool

Attempt to self-update?

pub fn update_only(&self) -> bool

Attempt to self-update without starting the node process

pub fn listen_on_loopback(&mut self)

Set the Quic-P2P ip configuration to 127.0.0.1.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

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 Eq for Config

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

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.

impl StructOpt for Config

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 Config

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>

impl StructuralEq for Config

impl StructuralPartialEq for Config