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 update_address(&mut self, peer: &PeerId, address: &Multiaddr) -> bool

Update an address record and notify swarm when the address is new.
Returns true when the address is new.

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

Update an address record without notifying swarm.
Returns true when the address is new.

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

Remove an address record. Returns true when the address is removed.

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

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 and notify the swarm about the update, dropping the old data if it exists.

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

Insert the data without notifying the swarm. Old data will be dropped if it exists.

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.
Will not wake up the task.

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 FromStore = 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<'_>, ) -> Option<Event<<MemoryStore<T> as Store>::FromStore>>

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