Struct network::application::storage::PeerMetadataStorage

pub struct PeerMetadataStorage { /* private fields */ }

Metadata storage for peers across all of networking. Splits storage of information across networks to prevent different networks from affecting each other

Implementations

impl PeerMetadataStorage

pub fn new(network_ids: &[NetworkId]) -> Arc<PeerMetadataStorage>

Create a new PeerMetadataStorage NetworkIds must be known at construction time

pub fn networks(&self) -> impl Iterator<Item = NetworkId> + '_

pub fn read(&self, peer_network_id: PeerNetworkId) -> Option<PeerInfo>

pub fn read_filtered<F: FnMut(&(&PeerId, &PeerInfo)) -> bool>(
    &self,
    network_id: NetworkId,
    filter: F
) -> HashMap<PeerNetworkId, PeerInfo>

pub fn keys(&self, network_id: NetworkId) -> Vec<PeerNetworkId>

pub fn read_all(&self, network_id: NetworkId) -> HashMap<PeerNetworkId, PeerInfo>

Read a clone of the entire state

pub fn insert(&self, peer_network_id: PeerNetworkId, new_value: PeerInfo)

Insert new entry

pub fn remove(&self, peer_network_id: &PeerNetworkId)

Remove old entries

pub fn write<F: FnOnce(&mut Entry<'_, PeerId, PeerInfo>) -> Result<(), PeerError>>(
    &self,
    peer_network_id: PeerNetworkId,
    modifier: F
) -> Result<(), PeerError>

Take in a function to modify the data, must handle concurrency control with the input function

pub fn write_lock(
    &self,
    network_id: NetworkId
) -> RwLockWriteGuard<'_, HashMap<PeerId, PeerInfo>>

Get the underlying RwLock of the map. Usage is discouraged as it leads to the possiblity of leaving the lock held for a long period of time. However, not everything fits into the write model.

pub fn insert_connection(
    &self,
    network_id: NetworkId,
    connection_metadata: ConnectionMetadata
)

pub fn remove_connection(
    &self,
    network_id: NetworkId,
    connection_metadata: &ConnectionMetadata
)

Trait Implementations

impl Debug for PeerMetadataStorage

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

Formats the value using the given formatter.