Struct misskey_websocket::WebSocketClientBuilder

pub struct WebSocketClientBuilder { /* private fields */ }

Builder for WebSocketClient.

Implementations

impl WebSocketClientBuilder

pub fn new<T>(url: T) -> Self where
    T: TryInto<Url>,
    T::Error: Into<Error>, 

Creates a new builder instance with url.

All configurations are set to default.

pub fn with_host<S>(host: S) -> Self where
    S: AsRef<str>, 

Creates a new builder instance with the given host name host.

This method configures the builder with a URL of the form wss://{host}/streaming. All other configurations are set to default.

pub fn token<S>(&mut self, token: S) -> &mut Self where
    S: AsRef<str>, 

Sets an API token.

This method appends the given token as the i query parameter to the URL.

pub fn query<S1, S2>(&mut self, key: S1, value: S2) -> &mut Self where
    S1: AsRef<str>,
    S2: AsRef<str>, 

Specifies additional query parameters for the URL.

pub fn auto_reconnect(&mut self, enable: bool) -> &mut Self

Sets whether or not to enable automatic reconnection.

Automatic reconnection is enabled by default (as per Default implementation for ReconnectConfig), and you can disable it with .auto_reconnect(false).

pub fn reconnect_secs(&mut self, secs: u64) -> &mut Self

Sets an interval duration of automatic reconnection in seconds.

pub fn reconnect_interval(&mut self, interval: Duration) -> &mut Self

Sets an interval duration of automatic reconnection.

pub fn reconnect_condition(
    &mut self,
    condition: ReconnectCondition
) -> &mut Self

Specifies the condition for reconnecting.

pub fn reconnect_retry_send(&mut self, enable: bool) -> &mut Self

Specifies whether to re-send messages that may have failed to be sent when reconnecting.

pub async fn connect(&self) -> Result<WebSocketClient, Error>

Finish this builder instance and connect to Misskey using this configuration.

Trait Implementations

impl Clone for WebSocketClientBuilder

fn clone(&self) -> WebSocketClientBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketClientBuilder

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

Formats the value using the given formatter.