Struct firma::common::cmd::Context

pub struct Context {
    pub network: Network,
    pub wallet_name: String,
    pub firma_datadir: String,
}

Fields

network: Network

Network (bitcoin, testnet, regtest)

wallet_name: String

Name of the wallet

firma_datadir: String

Directory where wallet info are saved

Implementations

impl Context

pub fn path_for_qr(&self, kind: Kind, name: Option<String>) -> Result<PathBuf>

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

pub fn filename_for_wallet(&self, name: &str) -> Result<PathBuf>

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

pub fn save_wallet(&self, wallet: &WalletJson) -> Result<PathBuf>

pub fn save_signature(&self, wallet: &WalletSignature) -> Result<PathBuf>

pub fn save_index(&self, indexes: &WalletIndexes) -> Result<()>

pub fn save_daemon_opts(&self, daemon_opts: &DaemonOpts) -> Result<()>

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

pub fn load_wallet_index_daemon(
    &self
) -> Result<(WalletJson, WalletIndexes, DaemonOpts)>

load the wallet and related indexes and daemon opts

Trait Implementations

impl Clone for Context

pub fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl StructOpt for Context

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

Returns clap::App corresponding to the struct.

pub 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 Context

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

pub fn is_subcommand() -> bool

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