tungstenite::client

Struct ClientRequestBuilder

Source
pub struct ClientRequestBuilder { /* private fields */ }
Expand description

Builder for a custom IntoClientRequest with options to add custom additional headers and sub protocols.

§Example

use http::Uri;
use tungstenite::{connect, ClientRequestBuilder};

let uri: Uri = "ws://localhost:3012/socket".parse().unwrap();
let token = "my_jwt_token";
let builder = ClientRequestBuilder::new(uri)
    .with_header("Authorization", format!("Bearer {token}"))
    .with_sub_protocol("my_sub_protocol");
let socket = connect(builder).unwrap();

Implementations§

Source§

impl ClientRequestBuilder

Source

pub const fn new(uri: Uri) -> Self

Initializes an empty request builder

Source

pub fn with_header<K, V>(self, key: K, value: V) -> Self
where K: Into<String>, V: Into<String>,

Adds (key, value) as an additional header to the handshake request

Source

pub fn with_sub_protocol<P>(self, protocol: P) -> Self
where P: Into<String>,

Adds protocol to the handshake request subprotocols (Sec-WebSocket-Protocol)

Trait Implementations§

Source§

impl Clone for ClientRequestBuilder

Source§

fn clone(&self) -> ClientRequestBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientRequestBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoClientRequest for ClientRequestBuilder

Source§

fn into_client_request(self) -> Result<Request>

Convert into a Request that can be used for a client connection.

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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