runtime-raw 0.3.0-alpha.5

Traits to implement custom Runtimes.
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

use futures::prelude::*;
use futures::task::{Context, Poll};

use std::fmt::Debug;
use std::io;
use std::net::SocketAddr;
use std::pin::Pin;

/// A TcpStream for this Runtime
pub trait TcpStream: AsyncRead + AsyncWrite + Debug + Send {
    /// Check if the stream can be written to.
    fn poll_write_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>>;

    /// Check if the stream can be read from.
    fn poll_read_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>>;

    /// Check if any socket errors exist on the `TcpStream`.
    ///
    /// Checking for socket errors is fallible, which is why the outer type is
    /// `Result`.
    fn take_error(&self) -> io::Result<Option<io::Error>>;

    /// Returns the local address that this stream is connected to.
    fn local_addr(&self) -> io::Result<SocketAddr>;

    /// Returns the remote address that this stream is connected to.
    fn peer_addr(&self) -> io::Result<SocketAddr>;

    /// Shuts down the read, write, or both halves of this connection.
    fn shutdown(&self, how: std::net::Shutdown) -> std::io::Result<()>;

    /// Extracts the raw file descriptor.
    #[cfg(unix)]
    fn as_raw_fd(&self) -> std::os::unix::io::RawFd;
}

/// A TcpListener for this Runtime
pub trait TcpListener: Debug + Send {
    /// Get the address the listener is listening on.
    fn local_addr(&self) -> io::Result<SocketAddr>;

    /// Check if the listener is ready to accept connections.
    fn poll_accept(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<io::Result<Pin<Box<dyn TcpStream>>>>;

    /// Extracts the raw file descriptor.
    #[cfg(unix)]
    fn as_raw_fd(&self) -> std::os::unix::io::RawFd;
}