Struct ws_tool::ClientBuilder

source · [−]

pub struct ClientBuilder { /* private fields */ }

Expand description

helper builder to construct websocket client

Implementations

source

impl ClientBuilder

source

pub async fn async_connect<C, F>(&self, check_fn: F) -> Result<C, WsError> where
F: Fn(String, Response<()>, BytesMut, WsAsyncStream<TcpStream>) -> Result<C, WsError>,

async version of connect

perform protocol handshake & check server response

source

impl ClientBuilder

source

pub fn new<S: ToString>(uri: S) -> Self

create builder with websocket url

source

pub fn protocol(self, protocol: String) -> Self

add protocols

source

pub fn protocols(self, protocols: Vec<String>) -> Self

set extension in handshake http header

NOTE it will clear protocols set by protocol method

source

pub fn extension(self, extension: String) -> Self

add protocols

source

pub fn extensions(self, extensions: Vec<String>) -> Self

set extension in handshake http header

NOTE it will clear protocols set by protocol method

source

pub fn version(self, version: u8) -> Self

set websocket version

add initial request header

source

pub fn headers(self, headers: HashMap<String, String>) -> Self

set initial request headers

NOTE it will clear header set by previous header method

Auto Trait Implementations

impl RefUnwindSafe for ClientBuilder

impl Send for ClientBuilder

impl Sync for ClientBuilder

impl Unpin for ClientBuilder

impl UnwindSafe for ClientBuilder

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ws_tool::ClientBuilder

Implementations

impl ClientBuilder

pub async fn async_connect<C, F>(&self, check_fn: F) -> Result<C, WsError> where F: Fn(String, Response<()>, BytesMut, WsAsyncStream<TcpStream>) -> Result<C, WsError>,

impl ClientBuilder

pub fn new<S: ToString>(uri: S) -> Self

pub fn protocol(self, protocol: String) -> Self

pub fn protocols(self, protocols: Vec<String>) -> Self

pub fn extension(self, extension: String) -> Self

pub fn extensions(self, extensions: Vec<String>) -> Self

pub fn version(self, version: u8) -> Self

pub fn header<K: ToString, V: ToString>(self, name: K, value: V) -> Self

pub fn headers(self, headers: HashMap<String, String>) -> Self

Auto Trait Implementations

impl RefUnwindSafe for ClientBuilder

impl Send for ClientBuilder

impl Sync for ClientBuilder

impl Unpin for ClientBuilder

impl UnwindSafe for ClientBuilder

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn async_connect<C, F>(&self, check_fn: F) -> Result<C, WsError> where
F: Fn(String, Response<()>, BytesMut, WsAsyncStream<TcpStream>) -> Result<C, WsError>,

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,