Skip to main content

PeerCache

Struct PeerCache 

Source
pub struct PeerCache { /* private fields */ }
Expand description

In-memory cache PeerKey → PeerCapabilities.

One instance per participant; its lifetime matches the participant itself. Thread safety is provided by the caller via Arc<Mutex<PeerCache>> or Arc<RwLock<PeerCache>> — the cache itself is intentionally not thread-safe, because per tick usually only one writer/reader task touches it.

Implementations§

Source§

impl PeerCache

Source

pub fn new() -> Self

Build an empty cache.

Source

pub fn len(&self) -> usize

Number of known peers.

Source

pub fn is_empty(&self) -> bool

true if no peer is known.

Source

pub fn insert(&mut self, key: PeerKey, caps: PeerCapabilities)

Full upsert. Overwrites an existing entry with the new capabilities. For partial updates use Self::update_partial.

Source

pub fn get(&self, key: &PeerKey) -> Option<&PeerCapabilities>

Reads the capabilities of a peer.

Source

pub fn update_partial(&mut self, key: PeerKey, update: &PeerCapabilities)

Merges new information into the existing entry. If the peer is new → it is inserted.

For the semantics see PeerCapabilities::merge_update.

Source

pub fn forget(&mut self, key: &PeerKey) -> Option<PeerCapabilities>

Removes a peer from the cache. Returns the old caps if present — handy for logging at session end.

Source

pub fn iter(&self) -> impl Iterator<Item = (&PeerKey, &PeerCapabilities)>

Iterator over all (PeerKey, PeerCapabilities) pairs.

Trait Implementations§

Source§

impl Clone for PeerCache

Source§

fn clone(&self) -> PeerCache

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PeerCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PeerCache

Source§

fn default() -> PeerCache

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.