[−][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: Debug> Debug 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> DerefMut for SslStream<S>
[src]
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>>
fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context,
bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>
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>>
Auto Trait Implementations
impl<S> Send for SslStream<S> where
S: Send,
S: Send,
impl<S> Sync for SslStream<S> where
S: Sync,
S: Sync,
impl<S> Unpin for SslStream<S> where
S: Unpin,
S: Unpin,
impl<S> !UnwindSafe for SslStream<S>
impl<S> !RefUnwindSafe for SslStream<S>
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> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
[src]
R: AsyncRead + ?Sized,
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
[src]
R: AsyncRead,
fn copy_into<W>(self, writer: &mut W) -> CopyInto<Self, W> where
W: AsyncWrite + Unpin + ?Sized,
[src]
W: AsyncWrite + Unpin + ?Sized,
fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
Self: Unpin,
fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_end(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
Self: AsyncWrite,
[src]
Self: AsyncWrite,
fn take(self, limit: u64) -> Take<Self>
[src]
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,
fn close(&mut self) -> Close<Self> where
Self: Unpin,
[src]
Self: Unpin,
fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self> where
Self: Unpin,
[src]
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self> where
Self: Unpin,
fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where
Self: Unpin,
[src]
Self: Unpin,
fn into_sink<Item>(self) -> IntoSink<Self, Item> where
Item: AsRef<[u8]>,
[src]
Item: AsRef<[u8]>,