dope-sys 0.30.1

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

use std::ops::ControlFlow;

use libc::socklen_t;

use crate::{
    Errno,
    io::reactor::{
        complete,
        read::{Arm, Call, Complete, Context, Family},
    },
    memory,
    memory::buffer,
    table::registry,
};

/// Native read records retaining the original descriptor and routed operation.
pub trait Entry<C: Context>:
    registry::Entry<
        Echo = C::Key,
        Family = Family,
        Call: Call<Key = C::Key, File = <Self as registry::Entry>::File>,
    >
{
    fn accept(
        file: Self::File,
        key: C::Key,
        addr: *mut libc::sockaddr_storage,
        len: *mut socklen_t,
        flow: C::Flow,
    ) -> Self;
    fn recv(file: Self::File, key: C::Key) -> Self;
    fn message(file: Self::File, key: C::Key) -> Self;
}

/// Drives one registered read while preserving its storage and completion borrows.
pub trait Poll<'a, C: Context, L: memory::raw::Layout, E: Complete<Key = C::Key, Flow = C::Flow>, P>:
    Sized
{
    type Arm: Arm<'a, C, E, P>;
    type Pool: buffer::Pool<Layout = L, Buffer = E::Buffer>;

    fn new(
        arm: Self::Arm,
        pool: &'a Self::Pool,
        query: registry::Query<<Self::Arm as Arm<'a, C, E, P>>::Entry>,
    ) -> Option<Self>;

    /// # Safety
    /// The registered read retains its submitted storage and admitted datagram layout.
    unsafe fn dispatch(
        self,
        filter: i16,
        error: Option<Errno>,
        vacant: impl complete::Vacancy<Event = E>,
    );

    /// A blocked receive remains queued and ends the current resume pass.
    ///
    /// # Safety
    /// The registered read retains its submitted storage and admitted datagram layout.
    unsafe fn resume(self, vacant: impl complete::Vacancy<Event = E>) -> ControlFlow<()>;
}