Struct WsConnect

pub struct WsConnect {
    pub url: String,
    pub auth: Option<Authorization>,
    pub config: Option<WebSocketConfig>,
}

Available on crate feature ws only.

Simple connection details for a websocket connection.

Fields

url: String

The URL to connect to.

auth: Option<Authorization>

The authorization header to use.

config: Option<WebSocketConfig>

The websocket config.

Implementations

impl WsConnect

pub fn new<S>(url: S) -> WsConnect

where S: Into<String>,

Creates a new websocket connection configuration.

pub fn with_auth(self, auth: Authorization) -> WsConnect

Sets the authorization header.

pub const fn with_config(self, config: WebSocketConfig) -> WsConnect

Sets the websocket config.

Trait Implementations

impl Clone for WsConnect

fn clone(&self) -> WsConnect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WsConnect

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

Formats the value using the given formatter.

impl IntoClientRequest for WsConnect

fn into_client_request(self) -> Result<Request<()>, Error>

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

impl PubSubConnect for WsConnect

fn is_local(&self) -> bool

Returns true if the transport connects to a local resource.

async fn connect( &self, ) -> Result<ConnectionHandle, RpcError<TransportErrorKind>>

Spawn the backend, returning a handle to it.

fn try_reconnect( &self, ) -> impl Send + Future<Output = Result<ConnectionHandle, RpcError<TransportErrorKind>>>

Attempt to reconnect the transport.

fn into_service( self, ) -> impl Send + Future<Output = Result<PubSubFrontend, RpcError<TransportErrorKind>>>

Convert the configuration object into a service with a running backend.