Struct MemoryStore

pub struct MemoryStore<T = ()> { /* private fields */ }

Available on crate feature peer-store only.

A in-memory store that uses LRU cache for bounded storage of addresses and a frequency-based ordering of addresses.

Implementations

impl<T> MemoryStore<T>

pub fn new(config: Config) -> MemoryStore<T>

Create a new MemoryStore with the given config.

pub fn add_address(&mut self, peer: &PeerId, address: &Multiaddr) -> bool

Add an address for a peer.

The added address will NOT be removed from the store on dial failure. If the added address is supposed to be cleared from the store on dial failure, add it by emitting FromSwarm::NewExternalAddrOfPeer to the swarm, e.g. via Swarm::add_peer_address.

Returns true if the address is new.

pub fn remove_address(&mut self, peer: &PeerId, address: &Multiaddr) -> bool

Remove an address record.

Returns true when the address existed.

pub fn get_custom_data(&self, peer: &PeerId) -> Option<&T>

Get a reference to a peer’s custom data.

pub fn take_custom_data(&mut self, peer: &PeerId) -> Option<T>

Take ownership of the internal data, leaving None in its place.

pub fn insert_custom_data(&mut self, peer: &PeerId, custom_data: T)

Insert the data, dropping the old data if it exists.

pub fn get_custom_data_mut(&mut self, peer: &PeerId) -> Option<&mut T>

Get a mutable reference to a peer’s custom data.

pub fn record_iter(&self) -> impl Iterator<Item = (&PeerId, &PeerRecord<T>)>

Iterate over all internal records.

pub fn record_iter_mut( &mut self, ) -> impl Iterator<Item = (&PeerId, &mut PeerRecord<T>)>

Iterate over all internal records mutably.

Changes to the records will not generate an event.

Trait Implementations

impl<T> Default for MemoryStore<T>

where T: Default,

fn default() -> MemoryStore<T>

Returns the “default value” for a type.

impl<T> Store for MemoryStore<T>

type Event = Event

Event generated by the store and emitted to Swarm. Behaviour cannot handle this event.

fn on_swarm_event(&mut self, swarm_event: &FromSwarm<'_>)

How this store handles events from Swarm.

fn addresses_of_peer( &self, peer: &PeerId, ) -> Option<impl Iterator<Item = &Multiaddr>>

Get all stored addresses of the peer.

fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<<MemoryStore<T> as Store>::Event>

Polls for things that the store should do.
The task should be waked up to emit events to Behaviour and Swarm.