Struct libp2p_kad::ProviderRecord

pub struct ProviderRecord {
    pub key: Key,
    pub provider: PeerId,
    pub expires: Option<Instant>,
    pub addresses: Vec<Multiaddr>,
}

A record stored in the DHT whose value is the ID of a peer who can provide the value on-demand.

Note: Two ProviderRecords as well as their corresponding hashes are equal iff their key and provider fields are equal. See the Hash and PartialEq implementations.

Fields

key: Key

The key whose value is provided by the provider.

provider: PeerId

The provider of the value for the key.

expires: Option<Instant>

The expiration time as measured by a local, monotonic clock.

addresses: Vec<Multiaddr>

The known addresses that the provider may be listening on.

Implementations

impl ProviderRecord

pub fn new<K>(key: K, provider: PeerId, addresses: Vec<Multiaddr>) -> Self

where K: Into<Key>,

Creates a new provider record for insertion into a RecordStore.

pub fn is_expired(&self, now: Instant) -> bool

Checks whether the provider record is expired w.r.t. the given Instant.

Trait Implementations

impl Clone for ProviderRecord

fn clone(&self) -> ProviderRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderRecord

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

Formats the value using the given formatter.

impl Hash for ProviderRecord

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProviderRecord

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ProviderRecord