hopr-api 1.10.0

Common high-level external and internal API traits used by hopr-lib to implement the HOPR protocol
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Network graph API traits: topology, pathfinding, and edge quality observations.
//!
//! - `NetworkGraphView` — read-only node/edge queries and graph identity
//! - `NetworkGraphConnectivity` — topology enumeration (connected/reachable edges)
//! - `NetworkGraphWrite` — graph mutation (add/remove nodes and edges)
//! - `NetworkGraphUpdate` — record measurements from probes and transport
//! - `NetworkGraphTraverse` — pathfinding (simple paths, loopbacks)
//! - `HoprGraphApi` — composite of all graph traits (full read+write access)
//! - `HoprGraphReadApi` — composite of view+traverse (read-only access)
//! - `ValueFn` — value function trait for path selection
//! - Edge observable traits for quality measurements (QoS, latency, capacity)

/// Edge/path value-function utilities used by graph traversal.
pub mod function;
/// Graph operation traits and observability interfaces.
pub mod traits;
/// Shared graph telemetry and measurement types.
pub mod types;

pub use traits::{
    EdgeImmediateProtocolObservable, EdgeLinkObservable, EdgeObservable, EdgeObservableRead, NetworkGraphConnectivity,
    NetworkGraphTraverse, NetworkGraphUpdate, NetworkGraphView, NetworkGraphWrite, ValueFn,
};
pub use types::*;

/// Read-only graph API for external consumers.
///
/// This trait is automatically implemented for types
/// that implement both [`NetworkGraphView`] and [`NetworkGraphTraverse`]
/// with the same node id.
pub trait HoprGraphReadApi:
    NetworkGraphView<NodeId = Self::HoprNodeId> + NetworkGraphTraverse<NodeId = Self::HoprNodeId>
{
    type HoprNodeId: Send;
}

impl<T, N> HoprGraphReadApi for T
where
    T: NetworkGraphView<NodeId = N> + NetworkGraphTraverse<NodeId = N>,
    N: Send,
{
    type HoprNodeId = N;
}

/// Complete set of HOPR graph operation APIs.
///
/// This trait is automatically implemented for types
/// that implement all the individual graph API traits with the same node id.
pub trait HoprGraphApi:
    NetworkGraphView<NodeId = Self::HoprNodeId>
    + NetworkGraphUpdate
    + NetworkGraphWrite<NodeId = Self::HoprNodeId>
    + NetworkGraphTraverse<NodeId = Self::HoprNodeId>
{
    type HoprNodeId: Send;
}

impl<T, N> HoprGraphApi for T
where
    T: NetworkGraphView<NodeId = N>
        + NetworkGraphUpdate
        + NetworkGraphWrite<NodeId = N>
        + NetworkGraphTraverse<NodeId = N>,
    N: Send,
{
    type HoprNodeId = N;
}