nuclei 0.5.2

Proactive IO & runtime system
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

//! IO: [`Handle`] (async operations on std's sockets and files), the
//! `futures-io` traits, and the utilities every stream gets: the reads and
//! writes of [`AsyncReadExt`], [`AsyncWriteExt`], [`AsyncBufReadExt`] and
//! [`AsyncSeekExt`] as futures, [`ReadBuf`], [`copy`] and
//! [`copy_bidirectional`], [`BufReader`], [`BufWriter`] and [`BufStream`],
//! the in-memory pipes [`duplex`] and [`simplex`], [`split`], [`empty`],
//! [`repeat`] and [`sink`], the process's [`stdin`], [`stdout`] and
//! [`stderr`], what the sockets' readiness calls take and answer
//! ([`Interest`], [`Ready`]), the caller's own buffers the owned calls take
//! and give back ([`IoBuf`], [`IoBufMut`], [`IoVecBuf`], [`IoVecBufMut`],
//! [`AlignedBuf`]), and on unix [`AsyncFd`](unix::AsyncFd), a caller's own
//! descriptor driven by readiness.
//!
//! Inside, the shards' half of IO: sources, the drivers' half of every
//! handle, and the system calls they make. A handle's IO object stays its own
//! (std's sockets and files); its source is what the shard's driver reaches.
//! The driver completes every operation, into and out of the pool's buffers,
//! at once when it can and on readiness otherwise, and wakes the task, which
//! takes the result.

#[cfg(unix)]
mod async_fd;
#[cfg(unix)]
pub(crate) mod caller;
pub(crate) mod handle;
pub(crate) mod raw;
mod ready;
pub(crate) mod side;
pub(crate) mod source;
pub(crate) mod sys;
mod util;

pub use futures_io::{AsyncBufRead, AsyncRead, AsyncSeek, AsyncWrite};

pub use self::handle::{Handle, IoObject};
pub use self::ready::{Interest, Ready};
pub use crate::buf::aligned::AlignedBuf;
pub use crate::buf::owned::{IoBuf, IoBufMut};
pub use crate::buf::vectored::{IoVecBuf, IoVecBufMut};

/// Unix's own: [`AsyncFd`](unix::AsyncFd), a caller's descriptor driven by
/// readiness, and its guards.
#[cfg(unix)]
pub mod unix {
    pub use super::async_fd::{AsyncFd, AsyncFdReadyGuard, AsyncFdReadyMutGuard, TryIoError};
}
pub(crate) use self::source::Source;
pub use self::util::{
    AsyncBufReadExt, AsyncReadExt, AsyncSeekExt, AsyncWriteExt, BufReader, BufStream, BufWriter,
    Chain, DuplexStream, Empty, FillBuf, Flush, Lines, Read, ReadBuf, ReadBufFuture, ReadExact,
    ReadHalf, ReadLine, ReadNumber, ReadToEnd, ReadToString, ReadUntil, Repeat, Seek, Shutdown,
    SimplexReader, SimplexWriter, Sink, Split, Stderr, Stdin, Stdout, Take, Write, WriteAll,
    WriteHalf, WriteNumber, WriteVectored, copy, copy_bidirectional, copy_bidirectional_with_sizes,
    copy_buf, duplex, empty, repeat, simplex, sink, split, stderr, stdin, stdout,
};