dope-sys 0.21.0

Typed operating-system call contracts
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

use crate::Errno;

mod packet;
mod stream;

pub use packet::Packet;
pub use stream::Stream;

/// A local transport carrying fixed u32 records through borrowed native prefixes.
pub trait Transport {
    /// Sends one record. Each successful leaf returns its completed input prefix.
    fn send(
        value: u32,
        send: impl for<'a> FnMut(&'a [u8]) -> Result<&'a [u8], Errno>,
    ) -> Result<(), Fault>;

    /// Receives one record. Each successful leaf returns its initialized output prefix.
    fn recv(recv: impl for<'a> FnMut(&'a mut [u8]) -> Result<&'a mut [u8], Errno>) -> Record;
}

#[derive(Debug)]
pub struct Size {
    pub expected: usize,
    /// Observed payload extent, capped at five bytes for an oversized record.
    pub actual: usize,
}

#[derive(Debug)]
pub enum Fault {
    Syscall(Errno),
    Record(Size),
}

#[derive(Debug)]
pub enum Record {
    Value(u32),
    Closed,
    Failed(Fault),
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum End {
    Left,
    Right,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Error {
    Open(Errno),
    Cloexec { end: End, error: crate::Cloexec },
    Sigpipe { end: End, error: Errno },
}