# Struct native_tls::TlsStream [−] [src]

    pub struct TlsStream<S>(_);

A stream managing a TLS session.

## Implementations

### `impl<S> TlsStream<S>` [src]

#### `pub fn get_ref(&self) -> &S` [src]

Returns a shared reference to the inner stream.

#### `pub fn get_mut(&mut self) -> &mut S` [src]

Returns a mutable reference to the inner stream.

### `impl<S: Read + Write> TlsStream<S>` [src]

#### `pub fn buffered_read_size(&self) -> Result<usize>` [src]

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

#### `pub fn peer_certificate(&self) -> Result<Option<Certificate>>` [src]

Returns the peer’s leaf certificate, if available.

#### `pub fn tls_server_end_point(&self) -> Result<Option<Vec<u8>>>` [src]

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

#### `pub fn shutdown(&mut self) -> Result<()>` [src]

Shuts down the TLS session.

## Trait Implementations

### `impl<S: Debug> Debug for TlsStream<S>` [src]

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

Formats the value using the given formatter. Read more

### `impl<S: Read + Write> Read for TlsStream<S>` [src]

#### `fn read(&mut self, buf: &mut [u8]) -> Result<usize>` [src]

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

#### `pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>`1.36.0 [src]

Like `read`, except that it reads into a slice of buffers. Read more

#### `pub fn is_read_vectored(&self) -> bool` [src]

🔬 This is a nightly-only experimental API. (`can_vector`)

Determines if this `Read`er has an efficient `read_vectored` implementation. Read more

#### `pub unsafe fn initializer(&self) -> Initializer` [src]

🔬 This is a nightly-only experimental API. (`read_initializer`)

Determines if this `Read`er can work with buffers of uninitialized memory. Read more

#### `pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>`1.0.0 [src]

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>`1.0.0 [src]

Read all bytes until EOF in this source, appending them to `buf`. Read more

#### `pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>`1.6.0 [src]

Read the exact number of bytes required to fill `buf`. Read more

#### `pub fn by_ref(&mut self) -> &mut Self` 1.0.0 [src]

Creates a “by reference” adaptor for this instance of `Read`. Read more

#### `pub fn bytes(self) -> Bytes<Self>`1.0.0 [src]

Transforms this `Read` instance to an `Iterator` over its bytes. Read more

#### `pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,` 1.0.0 [src]

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

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

Creates an adaptor which will read at most `limit` bytes from it. Read more

### `impl<S: Read + Write> Write for TlsStream<S>` [src]

#### `fn write(&mut self, buf: &[u8]) -> Result<usize>` [src]

Write a buffer into this writer, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<()>` [src]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>`1.36.0 [src]

Like `write`, except that it writes from a slice of buffers. Read more

#### `pub fn is_write_vectored(&self) -> bool` [src]

🔬 This is a nightly-only experimental API. (`can_vector`)

Determines if this `Write`r has an efficient `write_vectored` implementation. Read more

#### `pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>`1.0.0 [src]

Attempts to write an entire buffer into this writer. Read more

#### `pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>` [src]

🔬 This is a nightly-only experimental API. (`write_all_vectored`)

Attempts to write multiple buffers into this writer. Read more

#### `pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>`1.0.0 [src]

Writes a formatted string into this writer, returning any error encountered. Read more

#### `pub fn by_ref(&mut self) -> &mut Self` 1.0.0 [src]

Creates a “by reference” adaptor for this instance of `Write`. 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<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.