[−][src]Struct openssl_async::SslStream
An asynchronous SSL stream
Methods from Deref<Target = SslStream<AsStdIo<S>>>
pub fn ssl_read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
Like read
, but returns an ssl::Error
rather than an io::Error
.
It is particularly useful with a nonblocking socket, where the error value will identify if OpenSSL is waiting on read or write readiness.
This corresponds to SSL_read
.
pub fn ssl_write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
Like write
, but returns an ssl::Error
rather than an io::Error
.
It is particularly useful with a nonblocking socket, where the error value will identify if OpenSSL is waiting on read or write readiness.
This corresponds to SSL_write
.
pub fn shutdown(&mut self) -> Result<ShutdownResult, Error>
[src]
Shuts down the session.
The shutdown process consists of two steps. The first step sends a close notify message to
the peer, after which ShutdownResult::Sent
is returned. The second step awaits the receipt
of a close notify message from the peer, after which ShutdownResult::Received
is returned.
While the connection may be closed after the first step, it is recommended to fully shut the session down. In particular, it must be fully shut down if the connection is to be used for further communication in the future.
This corresponds to SSL_shutdown
.
pub fn get_shutdown(&mut self) -> ShutdownState
[src]
Returns the session's shutdown state.
This corresponds to SSL_get_shutdown
.
pub fn set_shutdown(&mut self, state: ShutdownState)
[src]
Sets the session's shutdown state.
This can be used to tell OpenSSL that the session should be cached even if a full two-way shutdown was not completed.
This corresponds to SSL_set_shutdown
.
pub fn get_ref(&self) -> &S
[src]
Returns a shared reference to the underlying stream.
pub fn get_mut(&mut self) -> &mut S
[src]
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.
pub fn ssl(&self) -> &SslRef
[src]
Returns a shared reference to the Ssl
object associated with this stream.
Trait Implementations
impl<S> DerefMut for SslStream<S>
[src]
impl<S> Deref for SslStream<S>
[src]
type Target = SslStream<AsStdIo<S>>
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
impl<S: Debug> Debug for SslStream<S>
[src]
impl<S> AsyncWrite for SslStream<S> where
S: AsyncWrite + AsyncRead + Unpin,
[src]
S: AsyncWrite + AsyncRead + Unpin,
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context,
buf: &[u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<()>>
[src]
fn poll_close(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<()>>
[src]
fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>
Attempt to write bytes from bufs
into the object using vectored IO operations. Read more
impl<S> AsyncRead for SslStream<S> where
S: Unpin + AsyncRead + AsyncWrite,
[src]
S: Unpin + AsyncRead + AsyncWrite,
fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context,
buf: &mut [u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
buf: &mut [u8]
) -> Poll<Result<usize>>
unsafe fn initializer(&self) -> Initializer
[src]
Determines if this AsyncRead
er can work with buffers of uninitialized memory. Read more
fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context,
vec: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
vec: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
Attempt to read from the AsyncRead
into bufs
using vectored IO operations. Read more
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
[src]
W: AsyncWrite + ?Sized,
fn flush(&mut self) -> Flush<Self> where
Self: Unpin,
[src]
Self: Unpin,
Creates a future which will entirely flush this AsyncWrite
. Read more
fn close(&mut self) -> Close<Self> where
Self: Unpin,
[src]
Self: Unpin,
Creates a future which will entirely close this AsyncWrite
.
fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
Write data into this object. Read more
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
R: AsyncRead + ?Sized,
fn copy_into<W>(&'a mut self, writer: &'a mut W) -> CopyInto<'a, Self, W> where
Self: Unpin,
W: AsyncWrite + Unpin,
[src]
Self: Unpin,
W: AsyncWrite + Unpin,
Creates a future which copies all the bytes from one object to another. Read more
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
Tries to read some bytes directly into the given buf
in asynchronous manner, returning a future type. Read more
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,
[src]
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 more
fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
Creates a future which will read all the bytes from this AsyncRead
. Read more
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
Helper method for splitting this read/write object into two halves. Read more