ssz_rs 0.9.0

ethereum's simple serialize
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

use crate::{de::DeserializeError, lib::*, merkleization::MerkleizationError, ser::SerializeError};

/// Top-level error to wrap all other errors in this crate
#[derive(Debug)]
pub enum Error {
    /// A serialization error.
    Serialize(SerializeError),
    /// A deserialization error.
    Deserialize(DeserializeError),
    /// A merkleization error.
    Merkleization(MerkleizationError),
    /// An invalid value.
    Instance(InstanceError),
    /// An invalid type.
    Type(TypeError),
}

impl From<SerializeError> for Error {
    fn from(err: SerializeError) -> Self {
        Self::Serialize(err)
    }
}

impl From<DeserializeError> for Error {
    fn from(err: DeserializeError) -> Self {
        Self::Deserialize(err)
    }
}

impl From<MerkleizationError> for Error {
    fn from(err: MerkleizationError) -> Self {
        Self::Merkleization(err)
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::Serialize(err) => write!(f, "could not serialize: {err}"),
            Self::Deserialize(err) => write!(f, "could not deserialize: {err}"),
            Self::Merkleization(err) => write!(f, "merkleization error: {err}"),
            Self::Instance(err) => write!(f, "error constructing instance: {err}"),
            Self::Type(err) => write!(f, "type error: {err}"),
        }
    }
}

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

/// An invalid type.
#[derive(Debug)]
pub enum TypeError {
    /// A type is invalid for the given bounds.
    InvalidBound(usize),
}

impl Display for TypeError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidBound(size) => {
                write!(f, "the type for this value is invalid with bound {size}")
            }
        }
    }
}

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

/// An invalid value.
#[derive(Debug)]
pub enum InstanceError {
    /// The number of elements did not match (`provided != required`)
    Exact { required: usize, provided: usize },
    /// The number of elements exceeded the maximum expected amount (`provided > bound`)
    Bounded { bound: usize, provided: usize },
}

impl Display for InstanceError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::Exact { required, provided } => write!(
                f,
                "required {required} elements for this type but {provided} elements given"
            ),
            Self::Bounded { bound, provided } => write!(
                f,
                "{provided} elements given for a type with (inclusive) upper bound {bound}"
            ),
        }
    }
}

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