Struct web3_async_native_tls::TlsStream[−][src]

pub struct TlsStream<S>(_);
Expand description

A stream managing a TLS session.

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.

Implementations

impl<S> TlsStream<S>[src]

pub fn get_ref(&self) -> &S where
    S: AsyncRead + AsyncWrite + Unpin, [src]

Returns a shared reference to the inner stream.

pub fn get_mut(&mut self) -> &mut S where
    S: AsyncRead + AsyncWrite + Unpin, [src]

Returns a mutable reference to the inner stream.

pub fn buffered_read_size(&self) -> Result<usize> where
    S: AsyncRead + AsyncWrite + Unpin, [src]

Returns the number of bytes that can be read without resulting in any network calls.

pub fn peer_certificate(&self) -> Result<Option<Certificate>> where
    S: AsyncRead + AsyncWrite + Unpin, [src]

Returns the peer’s leaf certificate, if available.

pub fn tls_server_end_point(&self) -> Result<Option<Vec<u8>>> where
    S: AsyncRead + AsyncWrite + Unpin, [src]

Returns the tls-server-end-point channel binding data as defined in RFC 5929.

Trait Implementations

impl<S> AsyncRead for TlsStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, [src]

fn poll_read(
    self: Pin<&mut Self>,
    ctx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>[src]

Attempt to read from the AsyncRead into buf. Read more

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations. Read more

impl<S> AsyncWrite for TlsStream<S> where
    S: AsyncRead + AsyncWrite + Unpin, [src]

fn poll_write(
    self: Pin<&mut Self>,
    ctx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize>>[src]

Attempt to write bytes from buf into the object. Read more

fn poll_flush(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Result<()>>[src]

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more

fn poll_close(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Result<()>>[src]

Attempt to close the object. Read more

fn poll_write_vectored(
    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: Debug> Debug for TlsStream<S>[src]

fn fmt(&self, f: &mut Formatter<'_>) -> Result[src]

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<S> RefUnwindSafe for TlsStream<S> where
    S: RefUnwindSafe, 

impl<S> Send for TlsStream<S> where
    S: Send, 

impl<S> Sync for TlsStream<S> where
    S: Sync, 

impl<S> Unpin for TlsStream<S> where
    S: Unpin, 

impl<S> UnwindSafe for TlsStream<S> where
    S: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<R> AsyncReadExt for R where
    R: AsyncRead + ?Sized, [src]

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

Creates an adaptor which will chain this stream with another. Read more

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self> where
    Self: Unpin, [src]

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

fn read_vectored(
    &'a mut self,
    bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self> where
    Self: Unpin, [src]

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self> where
    Self: Unpin, [src]

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, Global>
) -> ReadToEnd<'a, Self> where
    Self: Unpin, [src]

Creates a future which will read all the bytes from this AsyncRead. Read more

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self> where
    Self: Unpin, [src]

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]

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

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

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

impl<W> AsyncWriteExt for W where
    W: AsyncWrite + ?Sized, [src]

fn flush(&mut self) -> Flush<'_, Self> where
    Self: Unpin, [src]

Creates a future which will entirely flush this AsyncWrite. Read more

fn close(&mut self) -> Close<'_, Self> where
    Self: Unpin, [src]

Creates a future which will entirely close this AsyncWrite.

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> where
    Self: Unpin, [src]

Creates a future which will write bytes from buf into the object. Read more

fn write_vectored(
    &'a mut self,
    bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self> where
    Self: Unpin, [src]

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where
    Self: Unpin, [src]

Write data into this object. Read more

fn into_sink<Item>(self) -> IntoSink<Self, Item> where
    Item: AsRef<[u8]>, [src]

Allow using an [AsyncWrite] as a Sink<Item: AsRef<[u8]>>. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.