haematite 0.4.0

Content-addressed, branchable, actor-native storage engine
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use std::fmt;

use crate::ids::ShardId;
use crate::tree::Hash;

/// Errors raised by the hash-based sync protocol.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SyncError {
    MissingSourceNode {
        hash: Hash,
    },
    SourceStoreRead {
        hash: Hash,
    },
    TargetStoreRead {
        hash: Hash,
    },
    TargetStoreWrite {
        hash: Hash,
    },
    HashMismatch {
        expected: Hash,
        actual: Hash,
    },
    InvalidNodePayload,
    InvalidMessage,
    MessageTooLarge {
        len: usize,
    },
    ShardMismatch {
        expected: ShardId,
        actual: ShardId,
    },
    TargetRootMismatch {
        expected: Option<Hash>,
        actual: Option<Hash>,
    },
    TransportConnectionUnavailable,
    TransportConnectFailed,
    TransportWrite,
    /// The dedicated distribution runtime could not be constructed.
    TransportRuntimeUnavailable,
    /// Binding the distribution listener failed.
    TransportBind(String),
    /// The inbound-sync drain has no senders left (endpoint torn down).
    TransportDrainDisconnected,
    /// A blocking distribution call (`bind`/`connect`/`send`) was invoked from
    /// within a tokio runtime context, where its `block_on` bridge would panic.
    /// Returned instead of panicking; the caller must run it on a blocking thread
    /// (or drive the work via `DistributionEndpoint::runtime_handle`).
    TransportBlockingFromAsync,
}

impl fmt::Display for SyncError {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::MissingSourceNode { hash } => {
                write!(formatter, "source is missing tree node {hash}")
            }
            Self::SourceStoreRead { hash } => {
                write!(formatter, "failed to read source tree node {hash}")
            }
            Self::TargetStoreRead { hash } => {
                write!(formatter, "failed to read target tree node {hash}")
            }
            Self::TargetStoreWrite { hash } => {
                write!(formatter, "failed to store target tree node {hash}")
            }
            Self::HashMismatch { expected, actual } => write!(
                formatter,
                "node hash mismatch: expected {expected}, computed {actual}"
            ),
            Self::InvalidNodePayload => {
                formatter.write_str("sync message contains invalid node bytes")
            }
            Self::InvalidMessage => formatter.write_str("sync message is malformed"),
            Self::MessageTooLarge { len } => {
                write!(formatter, "sync message is too large to frame: {len} bytes")
            }
            Self::ShardMismatch { expected, actual } => write!(
                formatter,
                "sync response was for shard {actual}, expected shard {expected}"
            ),
            Self::TargetRootMismatch { expected, actual } => write!(
                formatter,
                "sync response target root {actual:?} did not match request target root {expected:?}"
            ),
            Self::TransportConnectionUnavailable => {
                formatter.write_str("beamr distribution connection is unavailable")
            }
            Self::TransportConnectFailed => {
                formatter.write_str("beamr distribution connection could not be established")
            }
            Self::TransportWrite => {
                formatter.write_str("failed to write sync frame to beamr connection")
            }
            Self::TransportRuntimeUnavailable => {
                formatter.write_str("distribution runtime could not be constructed")
            }
            Self::TransportBind(message) => {
                write!(formatter, "distribution listener bind failed: {message}")
            }
            Self::TransportDrainDisconnected => {
                formatter.write_str("distribution inbound drain is disconnected")
            }
            Self::TransportBlockingFromAsync => formatter.write_str(
                "blocking distribution call invoked from within an async runtime context",
            ),
        }
    }
}

impl std::error::Error for SyncError {}