hoy-protocol 0.2.0

Hoy real-time chat protocol 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

//! Hoy-protocol error definitions.

use thiserror::Error;

/// Errors produced by the Hoy protocol codec.
#[derive(Debug, Error)]
pub enum ProtocolError {
    /// The serialized payload length does not fit into a `u32` length prefix.
    #[error("Frame too large: {size} bytes")]
    FrameTooLarge {
        /// Payload size in bytes.
        size: usize,
    },

    /// The provided frame contains less bytes than declared in its header.
    #[error("Truncated frame")]
    TruncatedFrame,

    /// The provided frame header is malformed.
    #[error("Invalid frame length prefix")]
    InvalidLengthPrefix,

    /// The provided frame length cannot be represented by the current platform.
    #[error("Frame length cannot be represented on this platform: {length}")]
    FrameLengthOutOfRange {
        /// Raw frame length decoded from the wire.
        length: u32,
    },

    /// Failed to compute a valid buffer capacity for a frame.
    #[error("Frame capacity overflow")]
    CapacityOverflow,

    /// Attempt to discard an invalid number of bytes from a frame buffer.
    #[error("Attempted to discard {count}B from buffer of length {buffer_len}")]
    InvalidDiscard {
        /// Requested discard size.
        count: usize,

        /// Current buffer length.
        buffer_len: usize,
    },

    /// Serialization or deserialization error.
    #[error("Serialization error: {0}")]
    Serde(#[from] serde_json::Error),
}