Struct Config

pub struct Config {

    pub alias: Alias,
    pub listen: Vec<SocketAddr>,
    pub peers: PeerConfig,
    pub connect: HashSet<ConnectAddress>,
    pub external_addresses: Vec<Address>,
    pub proxy: Option<SocketAddr>,
    pub onion: Option<AddressConfig>,
    pub network: Network,
    pub log: Level,
    pub relay: Relay,
    pub limits: Limits,
    pub workers: usize,
    pub seeding_policy: DefaultSeedingPolicy,
    pub extra: Map<String, Value>,
}

Service configuration.

Fields

alias: Alias

Node alias.

listen: Vec<SocketAddr>

Socket address (a combination of IPv4 or IPv6 address and TCP port) to listen on.

peers: PeerConfig

Peer configuration.

connect: HashSet<ConnectAddress>

Peers to connect to on startup. Connections to these peers will be maintained.

external_addresses: Vec<Address>

Specify the node’s public addresses

proxy: Option<SocketAddr>

Global proxy.

onion: Option<AddressConfig>

Onion address config.

network: Network

Peer-to-peer network.

log: Level

Log level.

relay: Relay

Whether or not our node should relay messages.

limits: Limits

Configured service limits.

workers: usize

Number of worker threads to spawn.

seeding_policy: DefaultSeedingPolicy

Default seeding policy.

extra: Map<String, Value>

Extra fields that aren’t supported.

Implementations

impl Config

pub fn test(alias: Alias) -> Config

pub fn new(alias: Alias) -> Config

pub fn peer(&self, id: &PublicKey) -> Option<&Address>

pub fn peers(&self) -> impl Iterator<Item = PublicKey>

pub fn is_persistent(&self, id: &PublicKey) -> bool

pub fn is_relay(&self) -> bool

Are we a relay node? This determines what we do with gossip messages from other peers.

pub fn features(&self) -> Features

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>( __deserializer: __D, ) -> Result<Config, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.