Struct async_native_tls::TlsStream
source · pub struct TlsStream<S>(_);
Expand description
A stream managing a TLS session.
A wrapper around an underlying raw stream which implements the TLS or SSL protocol.
A TlsStream<S>
represents a handshake that has been completed successfully
and both the server and the client are ready for receiving and sending
data. Bytes read from a TlsStream
are decrypted from S
and bytes written
to a TlsStream
are encrypted when passing through to S
.
Implementations§
source§impl<S> TlsStream<S>
impl<S> TlsStream<S>
sourcepub fn get_ref(&self) -> &Swhere
S: AsyncRead + AsyncWrite + Unpin,
pub fn get_ref(&self) -> &Swhere S: AsyncRead + AsyncWrite + Unpin,
Returns a shared reference to the inner stream.
sourcepub fn get_mut(&mut self) -> &mut Swhere
S: AsyncRead + AsyncWrite + Unpin,
pub fn get_mut(&mut self) -> &mut Swhere S: AsyncRead + AsyncWrite + Unpin,
Returns a mutable reference to the inner stream.
sourcepub fn buffered_read_size(&self) -> Result<usize>where
S: AsyncRead + AsyncWrite + Unpin,
pub fn buffered_read_size(&self) -> Result<usize>where S: AsyncRead + AsyncWrite + Unpin,
Returns the number of bytes that can be read without resulting in any network calls.
sourcepub fn peer_certificate(&self) -> Result<Option<Certificate>>where
S: AsyncRead + AsyncWrite + Unpin,
pub fn peer_certificate(&self) -> Result<Option<Certificate>>where S: AsyncRead + AsyncWrite + Unpin,
Returns the peer’s leaf certificate, if available.
Trait Implementations§
source§impl<S> AsyncRead for TlsStream<S>where
S: AsyncRead + AsyncWrite + Unpin,
impl<S> AsyncRead for TlsStream<S>where S: AsyncRead + AsyncWrite + Unpin,
source§impl<S> AsyncWrite for TlsStream<S>where
S: AsyncRead + AsyncWrite + Unpin,
impl<S> AsyncWrite for TlsStream<S>where S: AsyncRead + AsyncWrite + Unpin,
source§fn poll_write(
self: Pin<&mut Self>,
ctx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_write( self: Pin<&mut Self>, ctx: &mut Context<'_>, buf: &[u8] ) -> Poll<Result<usize>>
Attempt to write bytes from
buf
into the object. Read moresource§fn poll_flush(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Result<()>>
fn poll_flush(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Result<()>>
Attempt to flush the object, ensuring that any buffered data reach
their destination. Read more
Auto Trait Implementations§
impl<S> RefUnwindSafe for TlsStream<S>where S: RefUnwindSafe,
impl<S> Send for TlsStream<S>where S: Send,
impl<S> Sync for TlsStream<S>where S: Sync,
impl<S> Unpin for TlsStream<S>where S: Unpin,
impl<S> UnwindSafe for TlsStream<S>where S: UnwindSafe,
Blanket Implementations§
source§impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,
impl<R> AsyncReadExt for Rwhere R: AsyncRead + ?Sized,
source§fn chain<R>(self, next: R) -> Chain<Self, R>where
Self: Sized,
R: AsyncRead,
fn chain<R>(self, next: R) -> Chain<Self, R>where Self: Sized, R: AsyncRead,
Creates an adaptor which will chain this stream with another. Read more
source§fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where Self: Unpin,
Tries to read some bytes directly into the given
buf
in asynchronous
manner, returning a future type. Read moresource§fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>where
Self: Unpin,
fn read_vectored<'a>( &'a mut self, bufs: &'a mut [IoSliceMut<'a>] ) -> ReadVectored<'a, Self>where Self: Unpin,
Creates a future which will read from the
AsyncRead
into bufs
using vectored
IO operations. Read moresource§fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where Self: Unpin,
Creates a future which will read exactly enough bytes to fill
buf
,
returning an error if end of file (EOF) is hit sooner. Read moresource§fn read_to_end<'a>(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEnd<'a, Self>where
Self: Unpin,
fn read_to_end<'a>( &'a mut self, buf: &'a mut Vec<u8, Global> ) -> ReadToEnd<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead
. Read moresource§fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToString<'a, Self>where
Self: Unpin,
fn read_to_string<'a>( &'a mut self, buf: &'a mut String ) -> ReadToString<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead
. Read moresource§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
impl<W> AsyncWriteExt for Wwhere W: AsyncWrite + ?Sized,
source§fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self>where Self: Unpin,
Creates a future which will entirely flush this
AsyncWrite
. Read moresource§fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,
fn close(&mut self) -> Close<'_, Self>where Self: Unpin,
Creates a future which will entirely close this
AsyncWrite
.source§fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where Self: Unpin,
Creates a future which will write bytes from
buf
into the object. Read moresource§fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
Self: Unpin,
fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>] ) -> WriteVectored<'a, Self>where Self: Unpin,
Creates a future which will write bytes from
bufs
into the object using vectored
IO operations. Read more