Struct TlsStream 

pub struct TlsStream<S, C = Connection>
where
    C: AsRef<Connection> + AsMut<Connection> + Unpin,
    S: AsyncRead + AsyncWrite + Unpin,
{ /* private fields */ }

Implementations

impl<S, C> TlsStream<S, C>

where C: AsRef<Connection> + AsMut<Connection> + Unpin, S: AsyncRead + AsyncWrite + Unpin,

pub fn get_ref(&self) -> &S

Access a shared reference to the underlaying io stream

pub fn get_mut(&mut self) -> &mut S

Access the mutable reference to the underlaying io stream

pub fn poll_blinding( self: Pin<&mut TlsStream<S, C>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Polls the blinding timer, if there is any.

s2n has a “blinding” functionality - when a bad behavior from the peer is detected, sleeps for 10-30 seconds before answering the client and closing the connection. This mitigates some timing side channels that could leak information about encrypted data. See the s2n_connection_set_blinding docs for more details.

For security reasons, to allow for blinding to correctly function, before dropping an s2n connection, you should wait until either poll_blinding or poll_shutdown (which calls poll_blinding internally) returns ready.

pub async fn apply_blinding(&mut self) -> Result<(), Error>

Trait Implementations

impl<S, C> AsMut<Connection> for TlsStream<S, C>

where C: AsRef<Connection> + AsMut<Connection> + Unpin, S: AsyncRead + AsyncWrite + Unpin,

fn as_mut(&mut self) -> &mut Connection

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S, C> AsRef<Connection> for TlsStream<S, C>

where C: AsRef<Connection> + AsMut<Connection> + Unpin, S: AsyncRead + AsyncWrite + Unpin,

fn as_ref(&self) -> &Connection

Converts this type into a shared reference of the (usually inferred) input type.

impl<S, C> AsyncRead for TlsStream<S, C>

where C: AsRef<Connection> + AsMut<Connection> + Unpin, S: AsyncRead + AsyncWrite + Unpin,

fn poll_read( self: Pin<&mut TlsStream<S, C>>, ctx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl<S, C> AsyncWrite for TlsStream<S, C>

where C: AsRef<Connection> + AsMut<Connection> + Unpin, S: AsyncRead + AsyncWrite + Unpin,

fn poll_write( self: Pin<&mut TlsStream<S, C>>, ctx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut TlsStream<S, C>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

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

fn poll_shutdown( self: Pin<&mut TlsStream<S, C>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<S, C> Debug for TlsStream<S, C>

where C: AsRef<Connection> + AsMut<Connection> + Unpin, S: AsyncRead + AsyncWrite + Unpin,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.