Skip to main content

Settings

Struct Settings 

Source
pub struct Settings {
    pub chain: PathBuf,
    pub dir: PathBuf,
    pub key_file: PathBuf,
    pub port: u16,
    pub interval: u64,
    pub tx_interval: u64,
    pub round: RoundConfig,
    pub pegout: PegoutConfig,
    pub relays: Vec<String>,
    pub mirrors: Vec<String>,
    pub parent: Option<ParentSettings>,
    pub journal: Option<PathBuf>,
}
Expand description

How a signer is run.

Fields§

§chain: PathBuf

The chain document.

§dir: PathBuf

The block file directory; pegins.json, pegouts.json and the journal live beside it.

§key_file: PathBuf

The key file (32-byte hex). Never a command-line value.

§port: u16

The HTTP port on 127.0.0.1. /blocks.dat serves only what the accepted index covers; POST /tx over MAX_TX_BODY bytes is 413.

§interval: u64

Seconds between blocks when the mempool is empty.

§tx_interval: u64

Seconds between blocks when it is not.

§round: RoundConfig

The round’s options.

§pegout: PegoutConfig

The peg-out round’s options (network filled from the document).

§relays: Vec<String>

Relays to follow and publish to.

§mirrors: Vec<String>

Mirrors to name in the tip announcement; none means no announcement.

§parent: Option<ParentSettings>

The parent node’s JSON-RPC, cookie file and peg wallet.

§journal: Option<PathBuf>

The block round’s vote journal; default <dir>/votes.jsonl. The peg-out round journals beside it in <stem>-pegout.jsonl (default <dir>/votes-pegout.jsonl): one file per round, one writer per file.

Trait Implementations§

Source§

impl Clone for Settings

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Settings

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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