Struct bitcoind::BitcoinD

pub struct BitcoinD {
    pub client: Client,
    pub config: Config,
    // some fields omitted
}

Struct representing the bitcoind process with related information

Fields

client: Client

Rpc client linked to this bitcoind process

config: Config

Node configuration, contains information to connect to this node

Implementations

impl BitcoinD

pub fn new<S: AsRef<OsStr>>(exe: S) -> Result<BitcoinD, Error>

Launch the bitcoind process from the given exe executable with default args Waits for the node to be ready before returning

pub fn with_args<S, I>(
    exe: S,
    custom_args: I,
    view_stdout: bool,
    p2p: P2P
) -> Result<BitcoinD, Error> where
    I: IntoIterator<Item = S>,
    S: AsRef<OsStr>, 

Launch the bitcoind process from the given exe executable with given args Waits for the node to be ready before returning args could be a vector of String containing no spaces like vec!["-dbcache=100".to_string()] view_stdout true will not suppress bitcoind log output p2p allows to specify options to open p2p port or connect to the another node datadir when None a temp directory is created as datadir, it will be deleted on drop provide a directory when you don’t want auto deletion (maybe because you can’t control

pub fn rpc_url(&self) -> String

Returns the rpc URL including the schema eg. http://127.0.0.1:44842

pub fn p2p_connect(&self) -> Option<P2P>

Returns the P2P enum to connect to this node p2p port

pub fn stop(&mut self) -> Result<ExitStatus, Error>

Stop the node, waiting correct process termination

Trait Implementations

impl Drop for BitcoinD

fn drop(&mut self)

Executes the destructor for this type.