Struct ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Establishes a WebSocket connection.

ws://... and wss://... URLs are supported.

Implementations

impl ClientBuilder

pub fn new(url: &str) -> Result<Self, ParseError>

Creates a ClientBuilder that connects to a given WebSocket URL.

This method returns an Err result if URL parsing fails.

pub fn from_url(url: Url) -> Self

Creates a ClientBuilder that connects to a given WebSocket URL.

This method never fails as the URL has already been parsed.

pub fn add_header(&mut self, name: String, value: String)

Adds an extra HTTP header for client

pub async fn async_connect_insecure(self) -> Result<AsyncClient<TokioTcpStream>>

Establishes a connection to the WebSocket server.

wss://... URLs are not supported by this method. Use async_connect if you need to be able to handle both ws://... and wss://... URLs.

pub fn connect_insecure(self) -> Result<Client<StdTcpStream>>

Establishes a connection to the WebSocket server.

wss://... URLs are not supported by this method. Use connect if you need to be able to handle both ws://... and wss://... URLs.

pub async fn async_connect( self, ) -> Result<AsyncClient<Box<dyn AsyncNetworkStream + Sync + Send + Unpin + 'static>>>

Establishes a connection to the WebSocket server.

pub fn connect( self, ) -> Result<Client<Box<dyn NetworkStream + Sync + Send + 'static>>>

Establishes a connection to the WebSocket server.

pub async fn async_connect_on<S: AsyncRead + AsyncWrite + Unpin>( self, stream: S, ) -> Result<AsyncClient<S>>

Takes over an already established stream and uses it to send and receive WebSocket messages.

This method assumes that the TLS connection has already been established, if needed. It sends an HTTP Connection: Upgrade request and waits for an HTTP OK response before proceeding.

pub fn connect_on<S: Read + Write>(self, stream: S) -> Result<Client<S>>

Takes over an already established stream and uses it to send and receive WebSocket messages.

This method assumes that the TLS connection has already been established, if needed. It sends an HTTP Connection: Upgrade request and waits for an HTTP OK response before proceeding.