# actix_web::ws::Client - Rust
API documentation for the Rust `Client` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Client

# [−] [src] Struct actix_web::ws::Client

    pub struct Client { /* fields omitted */ }

`WebSocket` client

Example of `WebSocket` client usage is available in websocket example

## Methods

###

`impl Client`

[src]

####

`pub fn new<S: AsRef<str>>(uri: S) -> Client`

[src]

Create new websocket connection

####

`pub fn with_connector<S: AsRef<str>>( uri: S, conn: Addr<ClientConnector> ) -> Client`

[src]

Create new websocket connection with custom `ClientConnector`

####

`pub fn protocols<U, V>(self, protos: U) -> Self where U: IntoIterator<Item = V> + 'static, V: AsRef<str>,`

[src]

Set supported websocket protocols

####

`pub fn cookie(self, cookie: Cookie) -> Self`

[src]

Set cookie for handshake request

####

`pub fn origin<V>(self, origin: V) -> Self where HeaderValue: HttpTryFrom<V>,`

[src]

Set request Origin

####

`pub fn max_frame_size(self, size: usize) -> Self`

[src]

Set max frame size

By default max size is set to 64kb

####

`pub fn write_buffer_capacity(self, cap: usize) -> Self`

[src]

Set write buffer capacity

Default buffer capacity is 32kb

####

`pub fn no_masking(self) -> Self`

[src]

Disable payload masking. By default ws client masks frame payload.

####

`pub fn header<K, V>(self, key: K, value: V) -> Self where HeaderName: HttpTryFrom<K>, V: IntoHeaderValue,`

[src]

Set request header

####

`pub fn timeout(self, timeout: Duration) -> Self`

[src]

Set websocket handshake timeout

Handshake timeout is a total time for successful handshake. Default value is 5 seconds.

####

`pub fn connect(&mut self) -> ClientHandshake`

[src]

Connect to websocket server and do ws handshake

## Auto Trait Implementations

###

`impl !Send for Client`

###

`impl !Sync for Client`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

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

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from`)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from`)

Performs the conversion.

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id`)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> Erased for T`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)