rapace-core 0.2.0

Core types and traits for rapace RPC
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

//! Frame types for sending and receiving.

use crate::MsgDescHot;

/// Owned frame for sending or storage.
#[derive(Debug, Clone)]
pub struct Frame {
    /// The frame descriptor.
    pub desc: MsgDescHot,
    /// Optional payload (None if inline or empty).
    pub payload: Option<Vec<u8>>,
}

impl Frame {
    /// Create a new frame with the given descriptor.
    pub fn new(desc: MsgDescHot) -> Self {
        Self {
            desc,
            payload: None,
        }
    }

    /// Create a frame with inline payload.
    pub fn with_inline_payload(mut desc: MsgDescHot, payload: &[u8]) -> Option<Self> {
        if payload.len() > crate::INLINE_PAYLOAD_SIZE {
            return None;
        }
        desc.payload_slot = crate::INLINE_PAYLOAD_SLOT;
        desc.payload_generation = 0;
        desc.payload_offset = 0;
        desc.payload_len = payload.len() as u32;
        desc.inline_payload[..payload.len()].copy_from_slice(payload);
        Some(Self {
            desc,
            payload: None,
        })
    }

    /// Create a frame with external payload.
    ///
    /// Note: For owned frames with external payload, we use a sentinel slot value (0)
    /// to distinguish from inline. The actual slot is only meaningful for SHM transport.
    pub fn with_payload(mut desc: MsgDescHot, payload: Vec<u8>) -> Self {
        // Mark as non-inline by setting slot to 0 (or any non-MAX value)
        // This is a sentinel for "payload is in the Frame::payload field"
        desc.payload_slot = 0;
        desc.payload_len = payload.len() as u32;
        Self {
            desc,
            payload: Some(payload),
        }
    }

    /// Get the payload bytes.
    pub fn payload(&self) -> &[u8] {
        if self.desc.is_inline() {
            self.desc.inline_payload()
        } else {
            self.payload.as_deref().unwrap_or(&[])
        }
    }
}

/// Borrowed view of a frame for zero-copy receive.
///
/// Lifetime is tied to the receive call that produced it.
/// Caller must process or copy before calling recv_frame again.
#[derive(Debug)]
pub struct FrameView<'a> {
    /// Reference to the frame descriptor.
    pub desc: &'a MsgDescHot,
    /// Reference to the payload bytes.
    pub payload: &'a [u8],
}

impl<'a> FrameView<'a> {
    /// Create a new frame view.
    pub fn new(desc: &'a MsgDescHot, payload: &'a [u8]) -> Self {
        Self { desc, payload }
    }

    /// Convert to an owned Frame (copies payload if needed).
    pub fn to_owned(&self) -> Frame {
        if self.desc.is_inline() {
            Frame {
                desc: *self.desc,
                payload: None,
            }
        } else {
            Frame {
                desc: *self.desc,
                payload: Some(self.payload.to_vec()),
            }
        }
    }
}