ironsbe-core 0.3.0

Core types and traits for IronSBE - zero-copy SBE encoding/decoding
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

//! Error types for IronSBE core operations.

use thiserror::Error;

/// Core error type for IronSBE operations.
#[derive(Debug, Error)]
pub enum Error {
    /// Buffer is too short for the requested operation.
    #[error("buffer too short: required {required} bytes, available {available} bytes")]
    BufferTooShort {
        /// Required buffer size in bytes.
        required: usize,
        /// Available buffer size in bytes.
        available: usize,
    },

    /// Template ID mismatch during decoding.
    #[error("template mismatch: expected {expected}, actual {actual}")]
    TemplateMismatch {
        /// Expected template ID.
        expected: u16,
        /// Actual template ID found.
        actual: u16,
    },

    /// Schema ID mismatch during decoding.
    #[error("schema mismatch: expected {expected}, actual {actual}")]
    SchemaMismatch {
        /// Expected schema ID.
        expected: u16,
        /// Actual schema ID found.
        actual: u16,
    },

    /// Invalid enum value encountered.
    #[error("invalid enum value: tag {tag}, value {value}")]
    InvalidEnumValue {
        /// Field tag/ID.
        tag: u16,
        /// Invalid value encountered.
        value: u64,
    },

    /// Invalid UTF-8 encoding in string field.
    #[error("invalid UTF-8 at offset {offset}")]
    InvalidUtf8 {
        /// Byte offset where invalid UTF-8 was found.
        offset: usize,
    },

    /// Offset out of bounds.
    #[error("offset {offset} out of bounds for buffer of size {size}")]
    OffsetOutOfBounds {
        /// Requested offset.
        offset: usize,
        /// Buffer size in bytes.
        size: usize,
    },

    /// Group iteration error.
    #[error("group iteration error: {message}")]
    GroupError {
        /// Error message.
        message: String,
    },

    /// Version incompatibility.
    #[error(
        "version incompatible: message version {message_version}, min supported {min_supported}"
    )]
    VersionIncompatible {
        /// Message version.
        message_version: u16,
        /// Minimum supported version.
        min_supported: u16,
    },
}

/// Result type alias for IronSBE core operations.
pub type Result<T> = std::result::Result<T, Error>;