Struct electrsd::ElectrsD

pub struct ElectrsD {
    pub client: RawClient<ElectrumPlaintextStream>,
    pub electrum_url: String,
    pub esplora_url: Option<String>,
    /* private fields */
}

Struct representing the bitcoind process with related information

Fields

client: RawClient<ElectrumPlaintextStream>

Electrum client connected to the electrs process

electrum_url: String

Url to connect to the electrum protocol (tcp)

esplora_url: Option<String>

Url to connect to esplora protocol (http)

Implementations

impl ElectrsD

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

Create a new electrs process connected with the given bitcoind and default args.

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

Create a new electrs process using given Conf connected with the given bitcoind

pub fn trigger(&self) -> Result<(), Error>

triggers electrs sync by sending the SIGUSR1 signal, useful to call after a block for example

pub fn workdir(&self) -> PathBuf

Return the current workdir path of the running electrs

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

terminate the electrs process

Trait Implementations

impl Drop for ElectrsD

fn drop(&mut self)

Executes the destructor for this type.