tdf 0.4.0

Library for deserializing and serializing tdf values from BlazeSDK
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

//! Error type used when decoding packets [`DecodeError`] and result
//! type alias [`DecodeResult`]

use super::tag::{Tag, TdfType};
use std::{error::Error, fmt::Display, str::Utf8Error};

/// Error type for errors that can occur while decoding a value
/// using the tdf decode
#[derive(Debug)]
pub enum DecodeError {
    /// The tag that was expected could not be found
    MissingTag {
        /// The tag that was being searched for
        tag: Tag,
        /// The type of the tag being searched for
        ty: TdfType,
    },
    /// The found tag was not of the correct type
    InvalidTagType {
        /// The tag which the type was invalid for
        tag: Tag,
        /// The expected tdf type
        expected: TdfType,
        /// The actual tdf type
        actual: TdfType,
    },
    /// Encountered an unexpected type when decoding a
    /// map or list
    InvalidType {
        /// The expected tdf type
        expected: TdfType,
        /// The actual tdf type
        actual: TdfType,
    },

    /// Encountered an unknown tag type
    UnknownType {
        /// The tag type value
        ty: u8,
    },

    /// Reached the end of the available bytes before
    /// a value could be obtained
    UnexpectedEof {
        /// The current reader cusor position
        cursor: usize,
        /// The number of bytes attempted to read
        wanted: usize,
        /// The remaining bytes in the reader slice
        remaining: usize,
    },

    /// Attempted to decode a str slice but the content wasn't valid utf-8
    InvalidUtf8Value(Utf8Error),

    /// Other error type with custom message
    Other(&'static str),
}

/// Type alias for result which could result in a Decode Error
pub type DecodeResult<T> = Result<T, DecodeError>;

/// Error implementation
impl Error for DecodeError {}

/// Display formatting implementation
impl Display for DecodeError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            DecodeError::MissingTag { tag, ty } => {
                write!(f, "Missing tag '{}' (type: {:?})", tag, ty)
            }
            DecodeError::InvalidTagType {
                tag,
                expected,
                actual,
            } => {
                write!(
                    f,
                    "Invalid tag type for '{}' (expected: {:?}, got: {:?})",
                    tag, expected, actual
                )
            }
            DecodeError::InvalidType { expected, actual } => {
                write!(
                    f,
                    "Unexpected tag type (expected: {:?}, got: {:?})",
                    expected, actual
                )
            }
            DecodeError::UnknownType { ty } => {
                write!(f, "Unknown tag type: {}", ty)
            }
            DecodeError::UnexpectedEof {
                cursor,
                wanted,
                remaining,
            } => {
                write!(
                    f,
                    "Unexpected end of file (cursor: {}, wanted: {}, remaining: {})",
                    cursor, wanted, remaining
                )
            }
            DecodeError::InvalidUtf8Value(err) => err.fmt(f),
            DecodeError::Other(err) => f.write_str(err),
        }
    }
}