moqtail 0.14.0

Draft 16-compliant Media-over-QUIC (MoQ) protocol library.
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
141
142
143
144

// Copyright 2025 The MOQtail Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::model::common::varint::{BufMutVarIntExt, BufVarIntExt};
use crate::model::error::ParseError;
use bytes::{Buf, Bytes, BytesMut};

pub const MAX_REASON_PHRASE_LEN: usize = 1024;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReasonPhrase {
  phrase: String,
}

impl ReasonPhrase {
  pub fn try_new(phrase: String) -> Result<Self, ParseError> {
    let len = phrase.len();
    if len > MAX_REASON_PHRASE_LEN {
      Err(ParseError::LengthExceedsMax {
        context: "ReasonPhrase::try_new",
        max: MAX_REASON_PHRASE_LEN,
        len,
      })
    } else {
      Ok(ReasonPhrase { phrase })
    }
  }

  pub fn serialize(&self) -> Result<Bytes, ParseError> {
    let data = self.phrase.as_bytes();
    let mut buf = BytesMut::new();
    buf.put_vi(data.len() as u64)?;
    buf.extend_from_slice(data);
    Ok(buf.freeze())
  }

  /// Decode from:  varint(length) || utf8‑bytes
  pub fn deserialize(bytes: &mut Bytes) -> Result<Self, ParseError> {
    let len_u64 = bytes.get_vi()?;
    let len: usize =
      len_u64
        .try_into()
        .map_err(|e: std::num::TryFromIntError| ParseError::CastingError {
          context: "ReasonPhrase::deserialize length",
          from_type: "u64",
          to_type: "usize",
          details: e.to_string(),
        })?;

    if len > MAX_REASON_PHRASE_LEN {
      return Err(ParseError::LengthExceedsMax {
        context: "reason phrase try_new",
        max: MAX_REASON_PHRASE_LEN,
        len,
      });
    }
    if bytes.remaining() < len {
      return Err(ParseError::NotEnoughBytes {
        context: "ReasonPhrase::value",
        needed: len,
        available: bytes.remaining(),
      });
    }
    let raw = bytes.copy_to_bytes(len);
    let phrase = String::from_utf8(raw.to_vec()).map_err(|e| ParseError::InvalidUTF8 {
      context: "ReasonPhrase::deserialize",
      details: e.to_string(),
    })?;
    Ok(ReasonPhrase { phrase })
  }
}

#[cfg(test)]
mod tests {
  use super::{MAX_REASON_PHRASE_LEN, ReasonPhrase};
  use crate::model::common::varint::BufMutVarIntExt;
  use bytes::{Buf, BytesMut};

  #[test]
  fn test_roundtrip() {
    let orig = ReasonPhrase::try_new("hello world".to_string()).unwrap();
    let mut buf = orig.serialize().unwrap();
    let got = ReasonPhrase::deserialize(&mut buf).unwrap();
    assert_eq!(orig, got);
    assert_eq!(buf.remaining(), 0);
  }

  #[test]
  fn test_empty_phrase() {
    let orig = ReasonPhrase::try_new(String::new()).unwrap();
    let mut buf = orig.serialize().unwrap();
    let got = ReasonPhrase::deserialize(&mut buf).unwrap();
    assert_eq!(orig, got);
    assert_eq!(buf.remaining(), 0);
  }

  #[test]
  fn test_serialize_too_long() {
    let long = "a".repeat(MAX_REASON_PHRASE_LEN + 1);
    let err = ReasonPhrase::try_new(long);
    assert!(err.is_err())
  }

  #[test]
  fn test_deserialize_length_exceeds_max() {
    let mut buf = BytesMut::new();
    buf.put_vi((MAX_REASON_PHRASE_LEN + 1) as u64).unwrap();
    let mut bytes = buf.freeze();
    let err = ReasonPhrase::deserialize(&mut bytes);
    assert!(err.is_err())
  }

  #[test]
  fn test_deserialize_insufficient_bytes() {
    let mut buf = BytesMut::new();
    buf.put_vi(3).unwrap();
    buf.extend_from_slice(b"ab");
    let mut bytes = buf.freeze();
    let err = ReasonPhrase::deserialize(&mut bytes);
    assert!(err.is_err())
  }

  #[test]
  fn test_deserialize_invalid_utf8() {
    // length=2, but bytes are invalid UTF-8
    let mut buf = BytesMut::new();
    buf.put_vi(2).unwrap();
    buf.extend_from_slice(&[0xff, 0xff]);
    let mut bytes = buf.freeze();
    let err = ReasonPhrase::deserialize(&mut bytes);
    assert!(err.is_err())
  }
}