Struct bitcoind::BitcoinD

source ·
pub struct BitcoinD {
    pub client: Client,
    pub params: ConnectParams,
    /* private fields */
}
Expand description

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§

source§

impl BitcoinD

source

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

source

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

source

pub fn rpc_url(&self) -> String

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

source

pub fn workdir(&self) -> PathBuf

Return the current workdir path of the running node

source

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

Returns the P2P enum to connect to this node p2p port

source

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

Stop the node, waiting correct process termination

source§

impl BitcoinD

source

pub fn from_downloaded() -> Result<BitcoinD>

Available on crate feature download only.

create BitcoinD struct with the downloaded executable.

source

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§

source§

impl Debug for BitcoinD

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for BitcoinD

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V