zeroproto 0.4.0

Zero-copy binary serialization runtime library
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

//! Error types for ZeroProto

#[cfg(not(feature = "std"))]
extern crate alloc;
#[cfg(not(feature = "std"))]
use alloc::string::String;
#[cfg(feature = "std")]
use std::string::String;

/// Result type for ZeroProto operations
pub type Result<T> = core::result::Result<T, Error>;

/// Errors that can occur during ZeroProto operations
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Error {
    /// Buffer is too small for the requested operation
    OutOfBounds,
    /// Invalid field type for the requested operation
    InvalidFieldType,
    /// Invalid UTF-8 in string field
    InvalidUtf8,
    /// Invalid data format
    InvalidFormat,
    /// Invalid message format
    InvalidMessage,
    /// Requested field is not present in the buffer
    MissingField,
    /// Custom error message
    Custom(String),
}

impl core::fmt::Display for Error {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Error::OutOfBounds => write!(f, "Buffer out of bounds"),
            Error::InvalidFieldType => write!(f, "Invalid field type"),
            Error::InvalidUtf8 => write!(f, "Invalid UTF-8 string"),
            Error::InvalidFormat => write!(f, "Invalid data format"),
            Error::InvalidMessage => write!(f, "Invalid message format"),
            Error::MissingField => write!(f, "Field not present"),
            Error::Custom(msg) => write!(f, "{}", msg),
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for Error {}

impl From<core::str::Utf8Error> for Error {
    fn from(_: core::str::Utf8Error) -> Self {
        Error::InvalidUtf8
    }
}

#[cfg(feature = "std")]
impl From<std::string::FromUtf8Error> for Error {
    fn from(_: std::string::FromUtf8Error) -> Self {
        Error::InvalidUtf8
    }
}