Struct websocket::stream::sync::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> TlsStream<S> where
S: Read + Write, [src][−]
S: Read + Write,
pub fn buffered_read_size(&self) -> Result<usize, Error>[src][−]
Returns the number of bytes that can be read without resulting in any network calls.
pub fn peer_certificate(&self) -> Result<Option<Certificate>, Error>[src][−]
Returns the peer’s leaf certificate, if available.
pub fn tls_server_end_point(&self) -> Result<Option<Vec<u8, Global>>, Error>[src][−]
Returns the tls-server-end-point channel binding data as defined in RFC 5929.
pub fn shutdown(&mut self) -> Result<(), Error>[src][−]
Shuts down the TLS session.
Trait Implementations
impl AsTcpStream for TlsStream<TcpStream>[src][+]
pub fn as_tcp(&self) -> &TcpStreamⓘ[src][−]
Get a borrow of the TcpStream
impl<S> Debug for TlsStream<S> where
S: Debug, [src][+]
S: Debug,
pub fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>[src][−]
Formats the value using the given formatter. Read more
impl<S> Read for TlsStream<S> where
S: Read + Write, [src][+]
S: Read + Write,
pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>[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][−]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
Like read, except that it reads into a slice of buffers. Read more
pub fn is_read_vectored(&self) -> bool[src][−]
can_vector)Determines if this Reader has an efficient read_vectored
implementation. Read more
pub unsafe fn initializer(&self) -> Initializer[src][−]
read_initializer)Determines if this Reader 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 Self1.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][−]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read, 1.0.0[src][−]
R: Read,
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> Write for TlsStream<S> where
S: Read + Write, [src][+]
S: Read + Write,
pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>[src][−]
Write a buffer into this writer, returning how many bytes were written. Read more
pub fn flush(&mut self) -> Result<(), Error>[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][−]
pub fn is_write_vectored(&self) -> bool[src][−]
can_vector)Determines if this Writer 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][−]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
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 Self1.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,
S: RefUnwindSafe,
impl<S> Send for TlsStream<S> where
S: Send,
S: Send,
impl<S> Sync for TlsStream<S> where
S: Sync,
S: Sync,
impl<S> Unpin for TlsStream<S> where
S: Unpin,
S: Unpin,
impl<S> UnwindSafe for TlsStream<S> where
S: UnwindSafe,
S: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src][+]
T: 'static + ?Sized,
pub fn type_id(&self) -> TypeId[src][−]
Gets the TypeId of self. Read more
impl<T> Borrow<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
pub fn borrow(&self) -> &T[src][−]
Immutably borrows from an owned value. Read more
impl<T> BorrowMut<T> for T where
T: ?Sized, [src][+]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src][−]
Mutably borrows from an owned value. Read more
impl<T> From<T> for T[src][+]
impl<T, U> Into<U> for T where
U: From<T>, [src][+]
U: From<T>,
impl<S> IntoWs for S where
S: Stream, [src][+]
S: Stream,
type Stream = S
The type of stream this upgrade process is working with (TcpStream, etc.)
type Error = (S, Option<Incoming<(Method, RequestUri)>>, Option<Buffer>, HyperIntoWsError)
An error value in case the stream is not asking for a websocket connection or something went wrong. It is common to also include the stream here. Read more
pub fn into_ws(
Self
) -> Result<WsUpgrade<<S as IntoWs>::Stream, Option<Buffer>>, <S as IntoWs>::Error>[src][−]
Self
) -> Result<WsUpgrade<<S as IntoWs>::Stream, Option<Buffer>>, <S as IntoWs>::Error>
Attempt to parse the start of a Websocket handshake, later with the returned
WsUpgrade struct, call accept to start a websocket client, and reject to
send a handshake rejection response. Read more
impl<S> NetworkStream for S where
S: Read + Write + AsTcpStream, [src]
S: Read + Write + AsTcpStream,
impl<R> ReadBytesExt for R where
R: Read + ?Sized, [src][+]
R: Read + ?Sized,
pub fn read_u8(&mut self) -> Result<u8, Error>[src][−]
Reads an unsigned 8 bit integer from the underlying reader. Read more
pub fn read_i8(&mut self) -> Result<i8, Error>[src][−]
Reads a signed 8 bit integer from the underlying reader. Read more
pub fn read_u16<T>(&mut self) -> Result<u16, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned 16 bit integer from the underlying reader. Read more
pub fn read_i16<T>(&mut self) -> Result<i16, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed 16 bit integer from the underlying reader. Read more
pub fn read_u24<T>(&mut self) -> Result<u32, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned 24 bit integer from the underlying reader. Read more
pub fn read_i24<T>(&mut self) -> Result<i32, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed 24 bit integer from the underlying reader. Read more
pub fn read_u32<T>(&mut self) -> Result<u32, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned 32 bit integer from the underlying reader. Read more
pub fn read_i32<T>(&mut self) -> Result<i32, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed 32 bit integer from the underlying reader. Read more
pub fn read_u48<T>(&mut self) -> Result<u64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned 48 bit integer from the underlying reader. Read more
pub fn read_i48<T>(&mut self) -> Result<i64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed 48 bit integer from the underlying reader. Read more
pub fn read_u64<T>(&mut self) -> Result<u64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned 64 bit integer from the underlying reader. Read more
pub fn read_i64<T>(&mut self) -> Result<i64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed 64 bit integer from the underlying reader. Read more
pub fn read_u128<T>(&mut self) -> Result<u128, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned 128 bit integer from the underlying reader. Read more
pub fn read_i128<T>(&mut self) -> Result<i128, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed 128 bit integer from the underlying reader. Read more
pub fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned n-bytes integer from the underlying reader. Read more
pub fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed n-bytes integer from the underlying reader. Read more
pub fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads an unsigned n-bytes integer from the underlying reader.
pub fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a signed n-bytes integer from the underlying reader.
pub fn read_f32<T>(&mut self) -> Result<f32, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more
pub fn read_f64<T>(&mut self) -> Result<f64, Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more
pub fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more
pub fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more
pub fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more
pub fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more
pub fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>[src][−]
Reads a sequence of signed 8 bit integers from the underlying reader. Read more
pub fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of signed 16 bit integers from the underlying reader. Read more
pub fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of signed 32 bit integers from the underlying reader. Read more
pub fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of signed 64 bit integers from the underlying reader. Read more
pub fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of signed 128 bit integers from the underlying reader. Read more
pub fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more
pub fn read_f32_into_unchecked<T>(
&mut self,
dst: &mut [f32]
) -> Result<(), Error> where
T: ByteOrder, [src][−]
&mut self,
dst: &mut [f32]
) -> Result<(), Error> where
T: ByteOrder,
please use read_f32_into instead
DEPRECATED. Read more
pub fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more
pub fn read_f64_into_unchecked<T>(
&mut self,
dst: &mut [f64]
) -> Result<(), Error> where
T: ByteOrder, [src][−]
&mut self,
dst: &mut [f64]
) -> Result<(), Error> where
T: ByteOrder,
please use read_f64_into instead
DEPRECATED. Read more
impl<S> Stream for S where
S: Read + Write, [src]
S: Read + Write,
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.
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][+]
U: TryFrom<T>,
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.
impl<T> Typeable for T where
T: Any, [+]
T: Any,
impl<W> WriteBytesExt for W where
W: Write + ?Sized, [src][+]
W: Write + ?Sized,
pub fn write_u8(&mut self, n: u8) -> Result<(), Error>[src][−]
Writes an unsigned 8 bit integer to the underlying writer. Read more
pub fn write_i8(&mut self, n: i8) -> Result<(), Error>[src][−]
Writes a signed 8 bit integer to the underlying writer. Read more
pub fn write_u16<T>(&mut self, n: u16) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned 16 bit integer to the underlying writer. Read more
pub fn write_i16<T>(&mut self, n: i16) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed 16 bit integer to the underlying writer. Read more
pub fn write_u24<T>(&mut self, n: u32) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned 24 bit integer to the underlying writer. Read more
pub fn write_i24<T>(&mut self, n: i32) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed 24 bit integer to the underlying writer. Read more
pub fn write_u32<T>(&mut self, n: u32) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned 32 bit integer to the underlying writer. Read more
pub fn write_i32<T>(&mut self, n: i32) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed 32 bit integer to the underlying writer. Read more
pub fn write_u48<T>(&mut self, n: u64) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned 48 bit integer to the underlying writer. Read more
pub fn write_i48<T>(&mut self, n: i64) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed 48 bit integer to the underlying writer. Read more
pub fn write_u64<T>(&mut self, n: u64) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned 64 bit integer to the underlying writer. Read more
pub fn write_i64<T>(&mut self, n: i64) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed 64 bit integer to the underlying writer. Read more
pub fn write_u128<T>(&mut self, n: u128) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned 128 bit integer to the underlying writer.
pub fn write_i128<T>(&mut self, n: i128) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed 128 bit integer to the underlying writer.
pub fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned n-bytes integer to the underlying writer. Read more
pub fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed n-bytes integer to the underlying writer. Read more
pub fn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes an unsigned n-bytes integer to the underlying writer. Read more
pub fn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a signed n-bytes integer to the underlying writer. Read more
pub fn write_f32<T>(&mut self, n: f32) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a IEEE754 single-precision (4 bytes) floating point number to the underlying writer. Read more
pub fn write_f64<T>(&mut self, n: f64) -> Result<(), Error> where
T: ByteOrder, [src][−]
T: ByteOrder,
Writes a IEEE754 double-precision (8 bytes) floating point number to the underlying writer. Read more