connexa 0.3.2

High level abtraction of rust-libp2p
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

pub mod dummy;
pub mod memory;

use libp2p::swarm::FromSwarm;
use libp2p::{Multiaddr, PeerId};
use std::fmt::Debug;
use std::task::{Context, Poll};

pub trait Store: Send + Sync + 'static {
    type Event: Debug + Send;

    /// Insert a new peer and associated address into the store
    fn insert(
        &mut self,
        peer_id: PeerId,
        address: Multiaddr,
    ) -> impl Future<Output = std::io::Result<()>> + Send + 'static;

    /// Remove a peer and all its associated addresses from the store
    fn remove(
        &mut self,
        peer_id: &PeerId,
    ) -> impl Future<Output = std::io::Result<Vec<Multiaddr>>> + Send + 'static;

    /// Remove a specific address associated with a peer from the store
    fn remove_address(
        &mut self,
        peer_id: &PeerId,
        address: &Multiaddr,
    ) -> impl Future<Output = std::io::Result<()>> + Send + 'static;

    /// Get all addresses associated with a peer
    fn address(
        &self,
        peer_id: &PeerId,
    ) -> impl Future<Output = std::io::Result<Vec<Multiaddr>>> + Send + 'static;

    /// Get all addresses in the peer store
    fn list_all(
        &self,
    ) -> impl Future<Output = std::io::Result<Vec<(PeerId, Vec<Multiaddr>)>>> + Send + 'static;

    /// Get all in-memory address associated with a peer.
    /// Note that this function assumes that the addresses are stored in memory
    fn in_memory_address(&self, peer_id: &PeerId) -> Vec<Multiaddr>;

    /// Handle swarm events to update the store state
    fn on_swarm_event(&mut self, event: &FromSwarm);

    /// Poll the store for events
    fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Event>;
}