desert_core 0.1.5

Binary serialization library for Rust (core crate)
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use crate::{RefId, StringId};
use std::array::TryFromSliceError;
use std::char::DecodeUtf16Error;
use std::fmt::{Display, Formatter};
use std::num::TryFromIntError;
use std::string::FromUtf8Error;

#[derive(Debug)]
pub enum Error {
    UnsupportedCharacter(char),
    FailedToDecodeCharacter(u32),
    LengthTooLarge,
    InvalidTimeZone(String),
    InputEndedUnexpectedly,
    CompressionFailure(String),
    DecompressionFailure(String),
    FailedToDecodeString(String),
    InvalidStringId(StringId),
    DeserializationFailure(String),
    UnknownFieldReferenceInEvolutionStep(String),
    InvalidConstructorName {
        constructor_name: String,
        type_name: String,
    },
    DeserializingNonExistingChunk(u8),
    FieldRemovedInSerializedVersion(String),
    FieldWithoutDefaultValueIsMissing(String),
    NonOptionalFieldSerializedAsNone(String),
    InvalidRefId(RefId),
    InvalidConstructorId {
        constructor_id: u32,
        type_name: String,
    },
    DeserializingTransientConstructor {
        constructor_name: String,
        type_name: String,
    },
    SerializingTransientConstructor {
        constructor_name: String,
        type_name: String,
    },
    SerializationFailure(String),
}

impl Display for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Error::UnsupportedCharacter(c) => write!(f, "Unsupported character: {}", c),
            Error::FailedToDecodeCharacter(c) => write!(f, "Failed to decode character: {}", c),
            Error::LengthTooLarge => write!(f, "Length too large"),
            Error::InvalidTimeZone(msg) => write!(f, "Invalid timezone: {}", msg),
            Error::InputEndedUnexpectedly => write!(f, "Input ended unexpectedly"),
            Error::CompressionFailure(msg) => write!(f, "Compression failure: {}", msg),
            Error::DecompressionFailure(msg) => write!(f, "Decompression failure: {}", msg),
            Error::FailedToDecodeString(msg) => write!(f, "Failed to decode string: {}", msg),
            Error::InvalidStringId(id) => write!(f, "Invalid string id: {}", id),
            Error::DeserializationFailure(msg) => write!(f, "Deserialization failure: {}", msg),
            Error::UnknownFieldReferenceInEvolutionStep(msg) => {
                write!(f, "Unknown field reference in evolution step: {msg}")
            }
            Error::InvalidConstructorName {
                constructor_name,
                type_name,
            } => write!(
                f,
                "Invalid constructor name: {constructor_name} for type: {type_name}"
            ),
            Error::DeserializingNonExistingChunk(chunk_id) => {
                write!(f, "Deserializing non existing chunk: {chunk_id}")
            }
            Error::FieldRemovedInSerializedVersion(field_name) => {
                write!(f, "Field removed in serialized version: {field_name}")
            }
            Error::FieldWithoutDefaultValueIsMissing(field_name) => {
                write!(f, "Field without default value is missing: {field_name}")
            }
            Error::NonOptionalFieldSerializedAsNone(field_name) => {
                write!(f, "Non optional field serialized as None: {field_name}")
            }
            Error::InvalidRefId(id) => write!(f, "Invalid reference id: {id}"),
            Error::InvalidConstructorId {
                constructor_id,
                type_name,
            } => write!(
                f,
                "Invalid constructor id: {constructor_id} for type: {type_name}"
            ),
            Error::DeserializingTransientConstructor {
                constructor_name,
                type_name,
            } => write!(
                f,
                "Deserializing transient constructor: {constructor_name} for type: {type_name}"
            ),
            Error::SerializingTransientConstructor {
                constructor_name,
                type_name,
            } => write!(
                f,
                "Serializing transient constructor: {constructor_name} for type: {type_name}"
            ),
            Error::SerializationFailure(message) => write!(f, "Serialization failure: {message}"),
        }
    }
}

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

impl From<TryFromIntError> for Error {
    fn from(_: TryFromIntError) -> Self {
        Error::LengthTooLarge
    }
}

#[cfg(feature = "chrono")]
impl From<chrono_tz::ParseError> for Error {
    fn from(msg: chrono_tz::ParseError) -> Self {
        Error::InvalidTimeZone(msg.to_string())
    }
}

impl From<TryFromSliceError> for Error {
    fn from(_: TryFromSliceError) -> Self {
        Error::InputEndedUnexpectedly
    }
}

impl From<DecodeUtf16Error> for Error {
    fn from(err: DecodeUtf16Error) -> Self {
        Error::FailedToDecodeCharacter(err.unpaired_surrogate() as u32)
    }
}

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

pub type Result<T> = std::result::Result<T, Error>;