base-scheduler 0.3.0

Explicit, runtime-independent scheduler capabilities for protocol libraries
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

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

use crate::{
    IoBuf, IoBufMut, SocketAddressView, SocketRecvMessage, SocketRecvMessageMut, SocketRecvResult,
};

/// A received payload owner paired with portable receive metadata. Other message implementations may retain their backend's native metadata instead.
pub struct OwnedSocketRecvMessage<Buffer: IoBuf> {
    result: SocketRecvResult,
    payload: Buffer,
}

impl<B: IoBuf> OwnedSocketRecvMessage<B> {
    /// `payload` must expose exactly the received bytes reported by `result.bytes`.
    pub fn new(result: SocketRecvResult, payload: B) -> Self {
        assert_eq!(
            result.bytes,
            payload.as_ref().len(),
            "receive metadata and payload lengths differ"
        );
        Self { result, payload }
    }
}

impl<B: IoBuf> SocketRecvMessage for OwnedSocketRecvMessage<B> {
    type Payload = B;

    fn address(&self) -> Option<impl SocketAddressView + '_> {
        self.result.address.as_ref()
    }

    fn payload(&self) -> &[u8] {
        self.payload.as_ref()
    }

    fn truncated(&self) -> bool {
        self.result.truncated
    }

    fn control_truncated(&self) -> bool {
        self.result.control_truncated
    }

    fn into_payload(self) -> B {
        self.payload
    }
}

impl<B: IoBufMut> SocketRecvMessageMut for OwnedSocketRecvMessage<B> {
    fn payload_mut(&mut self) -> &mut [u8] {
        self.payload.as_mut()
    }
}