Struct bitcoind::BitcoinD

pub struct BitcoinD {
    pub client: Client,
    pub params: ConnectParams,
    /* private fields */
}

Struct representing the bitcoind process with related information

Fields

client: Client

Rpc client linked to this bitcoind process

params: ConnectParams

Contains information to connect to this node

Implementations

impl BitcoinD

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

Launch the bitcoind process from the given exe executable with default args.

Waits for the node to be ready to accept connections before returning

pub fn with_conf<S: AsRef<OsStr>>(exe: S, conf: &Conf<'_>) -> Result<BitcoinD>

Launch the bitcoind process from the given exe executable with given Conf param

pub fn rpc_url(&self) -> String

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

pub fn workdir(&self) -> PathBuf

Return the current workdir path of the running node

pub fn p2p_connect(&self, listen: bool) -> Option<P2P>

Returns the P2P enum to connect to this node p2p port

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

Stop the node, waiting correct process termination

impl BitcoinD

pub fn from_downloaded() -> Result<BitcoinD>

Available on crate feature download only.

create BitcoinD struct with the downloaded executable.

pub fn from_downloaded_with_conf(conf: &Conf<'_>) -> Result<BitcoinD>

Available on crate feature download only.

create BitcoinD struct with the downloaded executable and given Conf.

Trait Implementations

impl Debug for BitcoinD

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

Formats the value using the given formatter.

impl Drop for BitcoinD

fn drop(&mut self)

Executes the destructor for this type.