Struct tungstenite::client::ClientRequestBuilder

pub struct ClientRequestBuilder { /* private fields */ }

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

impl ClientRequestBuilder

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

Initializes an empty request builder

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

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

impl Clone for ClientRequestBuilder

fn clone(&self) -> ClientRequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientRequestBuilder

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

Formats the value using the given formatter.

impl IntoClientRequest for ClientRequestBuilder

fn into_client_request(self) -> Result<Request>

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