moq-transport 0.14.2

Media over QUIC
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

// SPDX-FileCopyrightText: 2024-2026 Cloudflare Inc., Luke Curley, Mike English and contributors
// SPDX-FileCopyrightText: 2023-2024 Luke Curley and contributors
// SPDX-License-Identifier: MIT OR Apache-2.0

use super::BoundsExceeded;
use std::{io, string::FromUtf8Error, sync};
use thiserror::Error;

pub trait Decode: Sized {
    fn decode<B: bytes::Buf>(buf: &mut B) -> Result<Self, DecodeError>;

    // Helper function to make sure we have enough bytes to decode
    fn decode_remaining<B: bytes::Buf>(buf: &mut B, required: usize) -> Result<(), DecodeError> {
        let needed = required.saturating_sub(buf.remaining());
        if needed > 0 {
            Err(DecodeError::More(needed))
        } else {
            Ok(())
        }
    }
}

/// A decode error.
#[derive(Error, Debug, Clone)]
pub enum DecodeError {
    #[error("fill buffer")]
    More(usize),

    #[error("invalid payload length {0} got {1}")]
    InvalidLength(usize, usize),

    #[error("invalid string")]
    InvalidString(#[from] FromUtf8Error),

    #[error("invalid message: {0:?}")]
    InvalidMessage(u64),

    #[error("invalid subscribe location")]
    InvalidSubscribeLocation,

    #[error("invalid filter type")]
    InvalidFilterType,

    #[error("invalid fetch type")]
    InvalidFetchType,

    #[error("invalid group order")]
    InvalidGroupOrder,

    #[error("invalid object status")]
    InvalidObjectStatus,

    #[error("invalid header type")]
    InvalidHeaderType,

    #[error("invalid value")]
    InvalidValue,

    #[error("varint bounds exceeded")]
    BoundsExceeded(#[from] BoundsExceeded),

    // TODO move these to ParamError
    #[error("duplicate parameter: {0:?}")]
    DuplicateParameter(u64),

    #[error("missing parameter")]
    MissingParameter,

    #[error("invalid parameter")]
    InvalidParameter,

    #[error("io error: {0}")]
    Io(sync::Arc<io::Error>),

    #[error("key-value-pair length exceeded")]
    KeyValuePairLengthExceeded(),

    #[error("field '{0}' too large")]
    FieldBoundsExceeded(String),

    #[error("invalid datagram type")]
    InvalidDatagramType,
}

impl From<io::Error> for DecodeError {
    fn from(err: io::Error) -> Self {
        Self::Io(sync::Arc::new(err))
    }
}