Struct Config

#[non_exhaustive]
pub struct Config { /* private fields */ }

Available on crate feature identify only.

Configuration for the identify::Behaviour.

Implementations

impl Config

pub fn new(protocol_version: String, local_public_key: PublicKey) -> Config

Creates a new configuration for the identify Behaviour that advertises the given protocol version and public key.
Use new_with_signed_peer_record for signedPeerRecord support.

pub fn new_with_signed_peer_record( protocol_version: String, local_keypair: &Keypair, ) -> Config

Creates a new configuration for the identify Behaviour that advertises the given protocol version and public key.
The private key will be used to sign PeerRecord for verifiable address advertisement.

pub fn with_agent_version(self, v: String) -> Config

Configures the agent version sent to peers.

pub fn with_interval(self, d: Duration) -> Config

Configures the interval at which identification requests are sent to peers after the initial request.

pub fn with_push_listen_addr_updates(self, b: bool) -> Config

Configures whether new or expired listen addresses of the local node should trigger an active push of an identify message to all connected peers.

pub fn with_cache_size(self, cache_size: usize) -> Config

Configures the size of the LRU cache, caching addresses of discovered peers.

pub fn with_hide_listen_addrs(self, b: bool) -> Config

Configures whether we prevent sending out our listen addresses.

pub fn protocol_version(&self) -> &str

Get the protocol version of the Config.

pub fn local_public_key(&self) -> &PublicKey

Get the local public key of the Config.

pub fn agent_version(&self) -> &str

Get the agent version of the Config.

pub fn interval(&self) -> Duration

Get the interval of the Config.

pub fn push_listen_addr_updates(&self) -> bool

Get the push listen address updates boolean value of the Config.

pub fn cache_size(&self) -> usize

Get the cache size of the Config.

pub fn hide_listen_addrs(&self) -> bool

Get the hide listen address boolean value of the Config.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy 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.