Skip to main content

qualia_core_db/net/qdnf/frame/
encode.rs

1//! Caller-buffered QFrame encoder. No heap on success or failure.
2
3use super::errors::FrameError;
4use super::header::{FrameHeader, BASE_HEADER_LEN, MAGIC, MAX_FRAME_LEN, VERSION};
5
6/// Encode `header` and `payload` into `out`. Returns bytes written.
7///
8/// `out` must not overlap `payload`. The encoder never reads back from `out`.
9pub fn encode_frame(
10    header: &FrameHeader,
11    payload: &[u8],
12    out: &mut [u8],
13) -> Result<usize, FrameError> {
14    if header.version != VERSION {
15        return Err(FrameError::Unsupported);
16    }
17    if payload.len() > u16::MAX as usize {
18        return Err(FrameError::Capacity);
19    }
20    if payload.len() != header.payload_len as usize {
21        return Err(FrameError::Malformed);
22    }
23    let header_len = header.header_len as usize;
24    if header_len < BASE_HEADER_LEN {
25        return Err(FrameError::Malformed);
26    }
27    let total = header_len
28        .checked_add(payload.len())
29        .ok_or(FrameError::Range)?;
30    if total > MAX_FRAME_LEN {
31        return Err(FrameError::Capacity);
32    }
33    if out.len() < total {
34        return Err(FrameError::Capacity);
35    }
36    if header_len > BASE_HEADER_LEN {
37        return Err(FrameError::Unsupported);
38    }
39
40    out[0..4].copy_from_slice(&MAGIC);
41    out[4] = header.version;
42    out[5] = header.frame_type.as_u8();
43    out[6..8].copy_from_slice(&header.flags.to_be_bytes());
44    out[8..10].copy_from_slice(&header.header_len.to_be_bytes());
45    out[10..12].copy_from_slice(&header.payload_len.to_be_bytes());
46    out[12] = header.hop_limit;
47    out[13] = header.next_protocol as u8;
48    out[14..16].copy_from_slice(&[0, 0]);
49    out[16..32].copy_from_slice(&header.source_link_id.0);
50    out[32..48].copy_from_slice(&header.destination_link_id.0);
51    out[48..56].copy_from_slice(&header.flow_id.0);
52    out[56..64].copy_from_slice(&header.sequence.0.to_be_bytes());
53    out[64..80].copy_from_slice(&header.header_tag);
54    if !payload.is_empty() {
55        out[header_len..total].copy_from_slice(payload);
56    }
57    Ok(total)
58}
59
60#[cfg(test)]
61mod tests {
62    use super::*;
63    use crate::net::qdnf::registries::{FrameType, NextProtocol};
64
65    #[test]
66    fn encode_rejects_short_output() {
67        let header = FrameHeader::new(FrameType::DiscoveryBeacon, NextProtocol::QLink);
68        let mut out = [0u8; 16];
69        assert_eq!(
70            encode_frame(&header, &[], &mut out),
71            Err(FrameError::Capacity)
72        );
73    }
74
75    #[test]
76    fn encode_rejects_payload_len_mismatch() {
77        let header = FrameHeader::new(FrameType::DiscoveryBeacon, NextProtocol::QLink);
78        let mut out = [0u8; 128];
79        assert_eq!(
80            encode_frame(&header, &[1], &mut out),
81            Err(FrameError::Malformed)
82        );
83    }
84}