subc_protocol/
framed_body.rs1use std::{error::Error, fmt};
4
5use serde_json::Value;
6
7pub const MAX_FRAMED_HEAD_BYTES: usize = 65_536;
8pub const MAX_DECLARED_PAYLOAD_BYTES: usize = 8_388_608;
9
10#[derive(Debug, Clone, Copy, PartialEq, Eq)]
13#[non_exhaustive]
14pub enum FramedBodyError {
15 ShortBody,
16 EmptyHead,
17 HeadTooLarge,
18 HeadLongerThanBody,
19 InvalidJson,
20 HeadNotObject,
21}
22
23impl fmt::Display for FramedBodyError {
24 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
25 write!(f, "{self:?}")
26 }
27}
28
29impl Error for FramedBodyError {}
30
31pub fn encode(head: &Value, payload: &[u8]) -> Result<Vec<u8>, FramedBodyError> {
34 if !head.is_object() {
35 return Err(FramedBodyError::HeadNotObject);
36 }
37 let json = serde_json::to_vec(head).map_err(|_| FramedBodyError::InvalidJson)?;
38 if json.len() > MAX_FRAMED_HEAD_BYTES {
39 return Err(FramedBodyError::HeadTooLarge);
40 }
41 let mut body = Vec::with_capacity(4 + json.len() + payload.len());
42 body.extend_from_slice(&(json.len() as u32).to_be_bytes());
43 body.extend_from_slice(&json);
44 body.extend_from_slice(payload);
45 Ok(body)
46}
47
48pub fn decode(body: &[u8]) -> Result<(Value, &[u8]), FramedBodyError> {
50 let prefix = body.get(..4).ok_or(FramedBodyError::ShortBody)?;
51 let len = u32::from_be_bytes(prefix.try_into().expect("four-byte prefix")) as usize;
52 if len == 0 {
53 return Err(FramedBodyError::EmptyHead);
54 }
55 if len > MAX_FRAMED_HEAD_BYTES {
56 return Err(FramedBodyError::HeadTooLarge);
57 }
58 if len > body.len() - 4 {
59 return Err(FramedBodyError::HeadLongerThanBody);
60 }
61 let head: Value =
62 serde_json::from_slice(&body[4..4 + len]).map_err(|_| FramedBodyError::InvalidJson)?;
63 if !head.is_object() {
64 return Err(FramedBodyError::HeadNotObject);
65 }
66 Ok((head, &body[4 + len..]))
67}