Struct Opts

pub(crate) struct Opts {
    pub(crate) data_dir: Option<PathBuf>,
    pub(crate) our_id: Option<PeerId>,
    pub(crate) password: Option<String>,
    pub(crate) use_tor: bool,
    pub(crate) verbose: bool,
    pub(crate) command: Command,
}

Fields

data_dir: Option<PathBuf>

The working directory of the client containing the config and db

our_id: Option<PeerId>

Peer id of the guardian

password: Option<String>

Guardian password for authentication

use_tor: bool

Activate usage of Tor as the Connector when building the Client

verbose: bool

Activate more verbose logging, for full control use the RUST_LOG env variable

command: Command

Implementations

impl Opts

pub(crate) fn data_dir(&self) -> Result<&PathBuf, CliError>

pub(crate) async fn data_dir_create(&self) -> Result<&PathBuf, CliError>

Get and create if doesn’t exist the data dir

pub(crate) fn admin_client( &self, peer_urls: &BTreeMap<PeerId, SafeUrl>, api_secret: &Option<String>, ) -> Result<DynGlobalApi, CliError>

pub(crate) fn auth(&self) -> Result<ApiAuth, CliError>

pub(crate) async fn load_rocks_db(&self) -> Result<Database, CliError>

pub(crate) fn connector(&self) -> Connector

Trait Implementations

impl Args for Opts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for Opts

fn clone(&self) -> Opts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Opts

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl FromArgMatches for Opts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Opts

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::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 I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.