Struct openssl::ssl::SslStream
[−]
[src]
pub struct SslStream<S> { // some 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: Send> Send for SslStream<S>
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.