Struct electrsd::Conf

#[non_exhaustive]
pub struct Conf<'a> {
    pub args: Vec<&'a str>,
    pub view_stderr: bool,
    pub http_enabled: bool,
    pub network: &'a str,
    pub tmpdir: Option<PathBuf>,
    pub staticdir: Option<PathBuf>,
    /* private fields */
}

Electrs configuration parameters, implements a convenient Default for most common use.

Default values:

let mut conf = electrsd::Conf::default();
conf.args = vec!["-vvv"];
conf.view_stderr = false;
conf.http_enabled = false;
conf.network = "regtest";
conf.tmpdir = None;
conf.staticdir = None;
assert_eq!(conf, electrsd::Conf::default());

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

args: Vec<&'a str>

Electrsd command line arguments note that db-dir, cookie, cookie-file, daemon-rpc-addr, jsonrpc-import, electrum-rpc-addr, monitoring-addr, http-addr cannot be used cause they are automatically initialized.

view_stderr: bool

if true electrsd log output will not be suppressed

http_enabled: bool

if true electrsd exposes an esplora endpoint

network: &'a str

Must match bitcoind network

tmpdir: Option<PathBuf>

Optionally specify a temporary or persistent working directory for the electrs. electrs index files will be stored in this path. The following two parameters can be configured to simulate desired working directory configuration.

tmpdir is Some() && staticdir is Some() : Error. Cannot be enabled at same time. tmpdir is Some(temp_path) && staticdir is None : Create temporary directory at tmpdir path. tmpdir is None && staticdir is Some(work_path) : Create persistent directory at staticdir path. tmpdir is None && staticdir is None: Creates a temporary directory in OS default temporary directory (eg /tmp) or TEMPDIR_ROOT env variable path.

Temporary directory path

staticdir: Option<PathBuf>

Persistent directory path

Trait Implementations

impl<'a> Clone for Conf<'a>

fn clone(&self) -> Conf<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Conf<'a>

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

Formats the value using the given formatter.

impl Default for Conf<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> PartialEq<Conf<'a>> for Conf<'a>

fn eq(&self, other: &Conf<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Conf<'a>

impl<'a> StructuralEq for Conf<'a>

impl<'a> StructuralPartialEq for Conf<'a>