dope-sys 0.43.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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

use std::{ops, os::fd};

use o3::buffer::bytes::{self, bounded};

use crate::{
    Errno,
    io::{
        reactor::{
            complete,
            retry::{Attempt, Complete, Context, Entry, State},
        },
        socket::{addr, msg},
    },
    table,
    table::change,
};

/// A pending send whose borrowed inputs remain owned by its driver flight.
pub trait Send<C: Context>: Sized {
    fn bytes(input: bytes::Prefix<'_, { bounded::MAX }>) -> Self;
    fn message(header: &msg::Header) -> Self;

    /// # Safety
    /// The original input and every message pointee remain initialized, immutable, and live.
    /// Message iovecs and total bytes satisfy the original admitted ABI bounds.
    unsafe fn attempt(&self, file: fd::BorrowedFd<'_>) -> Attempt<C::Outcome>;

    fn connected(file: fd::BorrowedFd<'_>) -> Result<Attempt<C::Unit>, Errno>;
}

/// Drives retained writes while borrowing their descriptor and retry owners.
pub trait Write<'a, C: Context, E: Complete<C>, P>: Sized {
    type Files: table::Files<C::Slots>;
    type Entry: Entry;
    type State: State<Self::Entry>;
    type Send: Send<C>;
    type Failure;
    type Prepared: complete::Cancellation<Event = E>;

    fn new(files: &'a mut Self::Files, state: &'a mut Self::State, poll: &'a mut P) -> Self;
    fn prepare(self, key: C::Key) -> Result<Option<Self::Prepared>, Self::Failure>;
    fn take_fd(&mut self, fd: fd::RawFd) -> ops::ControlFlow<(), Option<C::Key>>;
    fn connect(
        &mut self,
        key: C::Key,
        slot: <C::Slots as change::raw::Slots>::Physical,
        addr: addr::Addr<'_>,
        vacant: impl complete::Vacancy<Event = E>,
    );
    fn shutdown(
        &mut self,
        key: C::Key,
        slot: <C::Slots as change::raw::Slots>::Physical,
        vacant: impl complete::Vacancy<Event = E>,
    );

    /// # Safety
    /// The retained input and every message pointee remain live with their admitted ABI bounds.
    unsafe fn dispatch(
        &mut self,
        key: C::Key,
        error: Option<Errno>,
        vacant: impl complete::Vacancy<Event = E>,
    );

    /// # Safety
    /// The original write input retains its admitted bounds and pointees through completion.
    unsafe fn send(
        &mut self,
        key: C::Key,
        slot: <C::Slots as change::raw::Slots>::Physical,
        write: Self::Send,
        vacant: impl complete::Vacancy<Event = E>,
    );
}