Struct openssl::ssl::SslStream

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

A stream wrapper which handles SSL encryption for an underlying stream.

Methods

impl<S: Read + Write> SslStream<S>

fn connect<T: IntoSsl>(ssl: T, stream: S) -> Result<Self, SslError>

Creates an SSL/TLS client operating over the provided stream.

fn accept<T: IntoSsl>(ssl: T, stream: S) -> Result<Self, SslError>

Creates an SSL/TLS server operating over the provided stream.

fn connect_generic<T: IntoSsl>(ssl: T,
                               stream: S)
                               -> Result<SslStream<S>, SslError>

Deprecated

Use connect.

fn accept_generic<T: IntoSsl>(ssl: T,
                              stream: S)
                              -> Result<SslStream<S>, SslError>

Deprecated

Use accept.

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

Like read, but returns an ssl::Error rather than an io::Error.

This is particularly useful with a nonblocking socket, where the error value will identify if OpenSSL is waiting on read or write readiness.

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

Like write, but returns an ssl::Error rather than an io::Error.

This is particularly useful with a nonblocking socket, where the error value will identify if OpenSSL is waiting on read or write readiness.

impl<S> SslStream<S>

fn get_ref(&self) -> &S

Returns a reference to the underlying stream.

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

Returns a mutable reference to the underlying stream.

Warning

It is inadvisable to read from or write to the underlying stream as it will most likely corrupt the SSL session.

fn ssl(&self) -> &Ssl

Returns the OpenSSL Ssl object associated with this stream.

impl SslStream<TcpStream>

fn try_clone(&self) -> Result<SslStream<TcpStream>>

Deprecated

This method does not behave as expected and will be removed in a future release.

Trait Implementations

impl<S: Clone + Read + Write> Clone for SslStream<S>

Deprecated

This method does not behave as expected and will be removed in a future release.

fn clone(&self) -> SslStream<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S> Debug for SslStream<S> where S: Debug

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<S: AsRawFd> AsRawFd for SslStream<S>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<S: Read + Write> Read for SslStream<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: Read + Write> Write for SslStream<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.