Struct bitcoin::cli::BitcoinOpts

pub struct BitcoinOpts {
    pub bitcoin_rpc_url: Option<String>,
    pub bitcoin_rpc_user: Option<String>,
    pub bitcoin_rpc_pass: Option<String>,
    pub bitcoin_connection_timeout_ms: u64,
    pub electrs_url: Option<String>,
    pub light: bool,
    pub bitcoin_wif: Option<PathBuf>,
}

Fields

bitcoin_rpc_url: Option<String>

bitcoin_rpc_user: Option<String>

bitcoin_rpc_pass: Option<String>

bitcoin_connection_timeout_ms: u64

Timeout in milliseconds to wait for connection to bitcoin-core.

electrs_url: Option<String>

Url of the electrs server. If unset, a default fallback is used depending on the detected network.

light: bool

Experimental: Run in light client mode

bitcoin_wif: Option<PathBuf>

File containing the WIF encoded Bitcoin private key

Implementations

impl BitcoinOpts

pub fn new_client_builder( &self, wallet_name: Option<String> ) -> BitcoinCoreBuilder

pub async fn new_client( &self, wallet_name: Option<String> ) -> Result<Arc<dyn BitcoinCoreApi + Send + Sync>, Error>

pub fn new_client_with_network( &self, wallet_name: Option<String>, network: Network ) -> Result<Arc<dyn BitcoinCoreApi + Send + Sync>, Error>

Trait Implementations

impl Args for BitcoinOpts

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.

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

Append to [Command] so it can update self.

impl Clone for BitcoinOpts

fn clone(&self) -> BitcoinOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BitcoinOpts

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 Debug for BitcoinOpts

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

Formats the value using the given formatter.

impl Default for BitcoinOpts

fn default() -> BitcoinOpts

Returns the “default value” for a type.

impl FromArgMatches for BitcoinOpts

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 BitcoinOpts

fn parse() -> Self

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

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

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

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

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>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 on error

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

Update from iterator, return Err on error.