#[non_exhaustive]pub struct Conf<'a> {
pub args: Vec<&'a str>,
pub view_stdout: bool,
pub p2p: P2P,
pub network: &'a str,
pub tmpdir: Option<PathBuf>,
pub staticdir: Option<PathBuf>,
pub attempts: u8,
}
Expand description
The node configuration parameters, implements a convenient Default for most common use.
#[non_exhaustive]
allows adding new parameters without breaking downstream users.
Users cannot instantiate the struct directly, they need to create it via the default()
method
and mutate fields according to their preference.
Default values:
let mut conf = bitcoind::Conf::default();
conf.args = vec!["-regtest", "-fallbackfee=0.0001"];
conf.view_stdout = false;
conf.p2p = bitcoind::P2P::No;
conf.network = "regtest";
conf.tmpdir = None;
conf.staticdir = None;
conf.attempts = 3;
assert_eq!(conf, bitcoind::Conf::default());
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.args: Vec<&'a str>
Bitcoind command line arguments containing no spaces like vec!["-dbcache=300", "-regtest"]
note that port
, rpcport
, connect
, datadir
, listen
cannot be used because they are automatically initialized.
view_stdout: bool
if true
bitcoind log output will not be suppressed
p2p: P2P
Allows to specify options to open p2p port or connect to the another node
network: &'a str
Must match what specified in args without dashes, needed to locate the cookie file directory with different/esoteric networks
tmpdir: Option<PathBuf>
Optionally specify a temporary or persistent working directory for the node. 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.
It may be useful for example to set to a ramdisk via TEMPDIR_ROOT
env option so that
bitcoin nodes spawn very fast because their datadirs are in RAM. Should not be enabled with persistent
mode, as it cause memory overflows.
Temporary directory path
staticdir: Option<PathBuf>
Persistent directory path
attempts: u8
Try to spawn the process attempt
time
The OS is giving available ports to use, however, they aren’t booked, so it could rarely happen they are used at the time the process is spawn. When retrying other available ports are returned reducing the probability of conflicts to negligible.