offline-protocol-core 0.22.0

Core types and data structures for the Offline Protocol SDK
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

//! Error types for the Offline Protocol SDK.

use thiserror::Error;

/// Result type alias using the core Error type.
pub type Result<T> = std::result::Result<T, Error>;

/// Core errors that can occur in the Offline Protocol SDK.
// Adding a variant to a public error enum is a breaking change without
// this attribute; downstream crates must carry a wildcard arm.
#[non_exhaustive]
#[derive(Debug, Error, Clone, PartialEq, Eq)]
pub enum Error {
    /// Invalid message format or content.
    #[error("Invalid message: {0}")]
    InvalidMessage(String),

    /// Invalid user ID format.
    #[error("Invalid user ID: {0}")]
    InvalidUserId(String),

    /// Invalid app ID format.
    #[error("Invalid app ID: {0}")]
    InvalidAppId(String),

    /// Invalid TTL value (must be > 0).
    #[error("Invalid TTL: {0}")]
    InvalidTTL(u8),

    /// Invalid hop count value.
    #[error("Invalid hop count: {0}")]
    InvalidHopCount(u8),

    /// Message serialization failed.
    #[error("Serialization error: {0}")]
    SerializationError(String),

    /// Message deserialization failed.
    #[error("Deserialization error: {0}")]
    DeserializationError(String),

    /// Invalid service ID format.
    #[error("Invalid service ID: {0}")]
    InvalidServiceId(String),

    /// Generic error with custom message.
    #[error("{0}")]
    Other(String),
}

impl From<serde_json::Error> for Error {
    fn from(err: serde_json::Error) -> Self {
        Error::SerializationError(err.to_string())
    }
}