async-io 2.3.4

Async I/O and timers
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
97
98
99
100
101
102
103

// SPDX-License-Identifier: MIT OR Apache-2.0

use polling::os::iocp::PollerIocpExt;
use polling::{Event, PollMode, Poller};
use std::fmt;
use std::io::Result;
use std::os::windows::io::{
    AsRawHandle, AsRawSocket, BorrowedHandle, BorrowedSocket, RawHandle, RawSocket,
};

/// The raw registration into the reactor.
#[doc(hidden)]
pub enum Registration {
    /// Raw socket handle on Windows.
    ///
    /// # Invariant
    ///
    /// This describes a valid socket that has not been `close`d. It will not be
    /// closed while this object is alive.
    Socket(RawSocket),

    /// Waitable handle for Windows.
    ///
    /// # Invariant
    ///
    /// This describes a valid waitable handle that has not been `close`d. It will not be
    /// closed while this object is alive.
    Handle(RawHandle),
}

unsafe impl Send for Registration {}
unsafe impl Sync for Registration {}

impl fmt::Debug for Registration {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Socket(raw) => fmt::Debug::fmt(raw, f),
            Self::Handle(handle) => fmt::Debug::fmt(handle, f),
        }
    }
}

impl Registration {
    /// Add this file descriptor into the reactor.
    ///
    /// # Safety
    ///
    /// The provided file descriptor must be valid and not be closed while this object is alive.
    pub(crate) unsafe fn new(f: BorrowedSocket<'_>) -> Self {
        Self::Socket(f.as_raw_socket())
    }

    /// Create a new [`Registration`] around a waitable handle.
    ///
    /// # Safety
    ///
    /// The provided handle must be valid and not be closed while this object is alive.
    pub(crate) unsafe fn new_waitable(f: BorrowedHandle<'_>) -> Self {
        Self::Handle(f.as_raw_handle())
    }

    /// Registers the object into the reactor.
    #[inline]
    pub(crate) fn add(&self, poller: &Poller, token: usize) -> Result<()> {
        // SAFETY: This object's existence validates the invariants of Poller::add
        unsafe {
            match self {
                Self::Socket(raw) => poller.add(*raw, Event::none(token)),
                Self::Handle(handle) => {
                    poller.add_waitable(*handle, Event::none(token), PollMode::Oneshot)
                }
            }
        }
    }

    /// Re-registers the object into the reactor.
    #[inline]
    pub(crate) fn modify(&self, poller: &Poller, interest: Event) -> Result<()> {
        // SAFETY: self.raw is a valid file descriptor
        match self {
            Self::Socket(raw) => {
                poller.modify(unsafe { BorrowedSocket::borrow_raw(*raw) }, interest)
            }
            Self::Handle(handle) => poller.modify_waitable(
                unsafe { BorrowedHandle::borrow_raw(*handle) },
                interest,
                PollMode::Oneshot,
            ),
        }
    }

    /// Deregisters the object from the reactor.
    #[inline]
    pub(crate) fn delete(&self, poller: &Poller) -> Result<()> {
        // SAFETY: self.raw is a valid file descriptor
        match self {
            Self::Socket(raw) => poller.delete(unsafe { BorrowedSocket::borrow_raw(*raw) }),
            Self::Handle(handle) => {
                poller.remove_waitable(unsafe { BorrowedHandle::borrow_raw(*handle) })
            }
        }
    }
}