prns-runtime 0.3.4

Runtime-neutral Personal Reticulum node contracts and manifold kernel
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

use crate::identity::IdentityHash;
use crate::routing::{
    BlackholeIdentityOutcome, BlackholeInsertFailure, BlackholedIdentity,
    UnblackholeIdentityOutcome,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum IdentityBlackholeSourceError {
    NodeStopped,
    Busy,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum IdentityBlackholeControlError {
    NodeStopped,
    Busy,
    CapacityExhausted,
    ReasonTooLong,
    DurabilityFailed,
}

impl From<BlackholeInsertFailure> for IdentityBlackholeControlError {
    fn from(failure: BlackholeInsertFailure) -> Self {
        match failure {
            BlackholeInsertFailure::CapacityExhausted => Self::CapacityExhausted,
            BlackholeInsertFailure::ReasonTooLong => Self::ReasonTooLong,
        }
    }
}

pub trait IdentityBlackholeSource {
    type Reason: AsRef<str> + Send;
    type Entries: IntoIterator<Item = BlackholedIdentity<Self::Reason>> + Send;

    fn blackholed_identities(
        &self,
    ) -> impl core::future::Future<Output = Result<Self::Entries, IdentityBlackholeSourceError>> + Send;

    fn is_blackholed(
        &self,
        identity: IdentityHash,
    ) -> impl core::future::Future<Output = Result<bool, IdentityBlackholeSourceError>> + Send;
}

pub trait IdentityBlackholeControl {
    fn blackhole_identity<'a>(
        &'a self,
        entry: BlackholedIdentity<&'a str>,
    ) -> impl core::future::Future<
        Output = Result<BlackholeIdentityOutcome, IdentityBlackholeControlError>,
    > + Send
           + 'a;

    fn unblackhole_identity(
        &self,
        identity: IdentityHash,
    ) -> impl core::future::Future<
        Output = Result<UnblackholeIdentityOutcome, IdentityBlackholeControlError>,
    > + Send;
}