Struct tokio_tls::TlsStream

pub struct TlsStream<S> { /* fields omitted */ }

[−] Expand description

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.

Methods

impl<S> TlsStream<S>

fn get_ref(&self) -> &TlsStream<S>[−]

Get access to the internal native_tls::TlsStream stream which also transitively allows access to S.

fn get_mut(&mut self) -> &mut TlsStream<S>[−]

Get mutable access to the internal native_tls::TlsStream stream which also transitively allows mutable access to S.

Trait Implementations

impl<S: Debug> Debug for TlsStream<S>

fn fmt(&self, __arg_0: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<S: Io> Read for TlsStream<S>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>[−]

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>[−]

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>[−]

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>[−]

Unstable (io)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read[−]

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>[−]

Creates an adaptor which will read at most limit bytes from it.

impl<S: Io> Write for TlsStream<S>

fn write(&mut self, buf: &[u8]) -> Result<usize>[−]

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>[−]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>[−]

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>[−]

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Write.

impl<S: Io> Io for TlsStream<S>

fn poll_read(&mut self) -> Async<()>[−]

Tests to see if this I/O object may be readable.

fn poll_write(&mut self) -> Async<()>[−]

Tests to see if this I/O object may be writable.

fn framed<C>(self, codec: C) -> Framed<Self, C> where C: Codec[−]

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)[−]

Helper method for splitting this read/write object into two halves.