Struct AddressBookConfig

pub struct AddressBookConfig {
    pub max_white_list_length: usize,
    pub max_gray_list_length: usize,
    pub peer_save_period: Duration,
}

The addressbook config exposed to users.

Fields

max_white_list_length: usize

The size of the white peer list.

The white list holds peers that have been connected to before.

Type | Number Valid values | >= 0 Examples | 1000, 500, 241

max_gray_list_length: usize

The size of the gray peer list.

The gray peer list holds peers that have been told about but not connected to cuprated.

Type | Number Valid values | >= 0 Examples | 1000, 500, 241

peer_save_period: Duration

The time period between address book saves.

Type | Duration Examples | { secs = 90, nanos = 0 }, { secs = 100, nano = 123 }

Implementations

impl AddressBookConfig

pub fn write_docs(doc: &mut dyn TableLike)

impl AddressBookConfig

pub fn address_book_config<Z: NetworkZone>( &self, cache_dir: &Path, network: Network, our_own_address: Option<Z::Addr>, ) -> AddressBookConfig<Z>

Returns the cuprate_address_book::AddressBookConfig.

Trait Implementations

impl Debug for AddressBookConfig

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

Formats the value using the given formatter.

impl Default for AddressBookConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AddressBookConfig

where AddressBookConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AddressBookConfig

fn eq(&self, other: &AddressBookConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for AddressBookConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AddressBookConfig

impl StructuralPartialEq for AddressBookConfig

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes