commonware-sync 2026.4.0

Synchronize state between a server and client.
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

//! Error types for the sync example.

use crate::net::ErrorCode;
use thiserror::Error;

/// Errors that can occur in the sync example.
#[derive(Debug, Error)]
pub enum Error {
    /// Stream error during communication
    #[error("stream error")]
    Network(#[from] commonware_stream::encrypted::Error),

    /// Received unexpected response type for a request
    #[error("unexpected response type for request {request_id}")]
    UnexpectedResponse { request_id: u64 },

    /// Server returned an error response
    #[error("server error (code: {code:?}): {message}")]
    Server { code: ErrorCode, message: String },

    /// Invalid request parameters
    #[error("invalid request: {0}")]
    InvalidRequest(String),

    /// Database operation failed
    #[error("database operation failed")]
    Database(#[from] commonware_storage::qmdb::Error<commonware_storage::mmr::Family>),

    /// Request channel to I/O task closed unexpectedly
    #[error("request channel closed - I/O task may have terminated")]
    RequestChannelClosed,

    /// Response channel closed before receiving response
    #[error("response channel closed for request {request_id}")]
    ResponseChannelClosed { request_id: u64 },

    /// Target update channel error
    #[error("target update channel error: {reason}")]
    TargetUpdateChannel { reason: String },

    /// Configuration error
    #[error("invalid configuration: {0}")]
    InvalidConfig(String),
}

impl Error {
    /// Convert this error to a protocol error code for transmission over the network.
    pub const fn to_error_code(&self) -> ErrorCode {
        match self {
            Self::InvalidRequest(_) => ErrorCode::InvalidRequest,
            Self::Database(_) => ErrorCode::DatabaseError,
            Self::Network(_) => ErrorCode::NetworkError,
            Self::RequestChannelClosed | Self::ResponseChannelClosed { .. } => {
                ErrorCode::InternalError
            }
            _ => ErrorCode::InternalError,
        }
    }
}