reactors 0.1.4

Performance-focused cross-platform asynchronous IO implementation
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

//! Reactor core traits.
//!

use std::{
    io::{Result, SeekFrom},
    task::{Poll, Waker},
    time::Duration,
};

/// File-based reactor pattern core trait.
pub trait Reactor {
    /// Poll reactor events once.
    fn poll_once(&mut self, duration: Duration) -> Result<usize>;
}

/// Reactor pattern support stream seek
pub trait ReactorHandleSeekable {
    /// Try to seek in file stream.
    fn seek(&mut self, pos: SeekFrom, waker: Waker, timeout: Option<Duration>)
        -> Poll<Result<u64>>;
}

/// Reactor file handle must implement this trait.
pub trait ReactorHandle: Sized {
    /// Buffer type for file write operators.
    type WriteBuffer<'cx>: Unpin
    where
        Self: 'cx;
    /// Buffer type for file read operators
    type ReadBuffer<'cx>: Unpin
    where
        Self: 'cx;

    /// Nonblock write data to this file.
    ///
    /// # parameters
    ///
    /// - `buffer` data buffer to write.
    /// - `waker` Writing task [`waking`](Waker) up handle.
    /// - `timeout` Timeout interval for write operations
    fn poll_write<'cx>(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buffer: Self::WriteBuffer<'cx>,

        timeout: Option<Duration>,
    ) -> Poll<Result<usize>>;

    /// Nonblock read data from this file.
    ///
    /// # parameters
    ///
    /// - `buffer` data buffer to write.
    /// - `waker` Reading task [`waking`](Waker) up handle.
    /// - `timeout` Timeout interval for write operations
    fn poll_read<'cx>(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buffer: Self::ReadBuffer<'cx>,
        timeout: Option<Duration>,
    ) -> Poll<Result<usize>>;

    /// Close reactor handle.
    fn poll_close(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> Poll<Result<()>>;
}