Struct LocalStream

pub struct LocalStream {
    w: Sender<Result<Vec<u8>>>,
    r: Receiver<Result<Vec<u8>>>,
    pending_bytes: Vec<u8>,
    pub(crate) tls_cert: Option<Vec<u8>>,
}

One half of a pair of linked streams returned by stream_pair.

Fields

w: Sender<Result<Vec<u8>>>

The writing side of the channel that we use to implement this stream.

The reading side is held by the other linked stream.

r: Receiver<Result<Vec<u8>>>

The reading side of the channel that we use to implement this stream.

The writing side is held by the other linked stream.

pending_bytes: Vec<u8>

Bytes that we have read from r but not yet delivered.

tls_cert: Option<Vec<u8>>

Data about the other side of this stream’s fake TLS certificate, if any. If this is present, I/O operations will fail with an error.

How this is intended to work: things that return LocalStreams that could potentially be connected to a fake TLS listener should set this field. Then, a fake TLS wrapper type would clear this field (after checking its contents are as expected).

FIXME(eta): this is a bit of a layering violation, but it’s hard to do otherwise

Implementations

impl LocalStream

pub async fn send_err(&mut self, kind: ErrorKind)

Send an error to the other linked local stream.

When the other stream reads this message, it will generate a std::io::Error with the provided ErrorKind.

Trait Implementations

impl AsyncRead for LocalStream

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<IoResult<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for LocalStream

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<IoResult<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<IoResult<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<IoResult<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl StreamOps for LocalStream

fn set_tcp_notsent_lowat(&self, _notsent_lowat: u32) -> IoResult<()>

Set the TCP_NOTSENT_LOWAT socket option, if this Stream is a TCP stream.

fn new_handle(&self) -> Box<dyn StreamOps + Unpin + Send>

Return a new handle that implements [StreamOps], and that can be used independently of self.

impl TlsConnector<LocalStream> for MockTlsConnector

type Conn = MockTlsStream

The type of connection returned by this connector

fn negotiate_unvalidated<'life0, 'life1, 'async_trait>( &'life0 self, stream: LocalStream, _sni_hostname: &'life1 str, ) -> Pin<Box<dyn Future<Output = IoResult<MockTlsStream>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Start a TLS session over the provided TCP stream stream.

impl TlsProvider<LocalStream> for MockNetProvider

type Connector = MockTlsConnector

The Connector object that this provider can return.

type TlsStream = MockTlsStream

The type of the stream returned by that connector.

fn tls_connector(&self) -> MockTlsConnector

Return a TLS connector for use with this runtime.

fn supports_keying_material_export(&self) -> bool

Return true iff the keying material exporters (RFC 5705) is supported.