Client

Struct Client 

Source
pub struct Client<'a, T> { /* private fields */ }
Expand description

Websocket client handshake.

Implementations§

Source§

impl<'a, T: AsyncRead + AsyncWrite + Unpin> Client<'a, T>

Source

pub fn new(socket: T, host: &'a str, resource: &'a str) -> Self

Create a new client handshake for some host and resource.

Source

pub fn set_buffer(&mut self, b: BytesMut) -> &mut Self

Override the buffer to use for request/response handling.

Source

pub fn take_buffer(&mut self) -> BytesMut

Extract the buffer.

Source

pub fn set_headers(&mut self, h: &'a [Header<'_>]) -> &mut Self

Set connection headers to a slice. These headers are not checked for validity, the caller of this method is responsible for verification as well as avoiding conflicts with internally set headers.

Source

pub fn add_protocol(&mut self, p: &'a str) -> &mut Self

Add a protocol to be included in the handshake.

Source

pub fn add_extension(&mut self, e: Box<dyn Extension + Send>) -> &mut Self

Add an extension to be included in the handshake.

Source

pub fn drain_extensions( &mut self, ) -> impl Iterator<Item = Box<dyn Extension + Send>> + '_

Get back all extensions.

Source

pub async fn handshake(&mut self) -> Result<ServerResponse, Error>

Initiate client handshake request to server and get back the response.

Source

pub fn into_builder(self) -> Builder<T>

Turn this handshake into a connection::Builder.

Source

pub fn into_inner(self) -> T

Get out the inner socket of the client.

Trait Implementations§

Source§

impl<'a, T: Debug> Debug for Client<'a, T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for Client<'a, T>
where T: Freeze,

§

impl<'a, T> !RefUnwindSafe for Client<'a, T>

§

impl<'a, T> Send for Client<'a, T>
where T: Send,

§

impl<'a, T> !Sync for Client<'a, T>

§

impl<'a, T> Unpin for Client<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for Client<'a, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V