Struct misskey::WebSocketClient

pub struct WebSocketClient { /* private fields */ }

Available on crate feature websocket-client only.

Asynchronous WebSocket-based client for Misskey.

WebSocketClient can be constructed using WebSocketClient::connect or WebSocketClientBuilder. The latter is more flexible and intuitive.

You do not have to wrap this in Arc and Mutex to share it because WebSocketClient is already Clone and every methods of WebSocketClient takes &self, i.e. they does not require mutability.

Implementations

impl WebSocketClient

pub async fn connect(url: Url) -> Result<WebSocketClient, Error>

Connects to Misskey using WebSocket, and returns WebSocketClient.

pub async fn connect_with_config(
    url: Url,
    reconnect_config: ReconnectConfig
) -> Result<WebSocketClient, Error>

Connects to Misskey using WebSocket with a given reconnect configuration, and returns WebSocketClient.

pub fn builder<T>(url: T) -> WebSocketClientBuilder where
    T: TryInto<Url>,
    <T as TryInto<Url>>::Error: Into<Error>, 

Creates a new builder instance with url. All configurations are set to default.

This function is identical to WebSocketClientBuilder::new.

pub fn subnote<E, Id>(
    &self,
    note_id: Id
) -> Pin<Box<dyn Future<Output = Result<SubNote<E>, Error>> + Send + 'static, Global>> where
    E: SubNoteEvent,
    Id: Into<String>, 

Captures the note specified by id.

The returned SubNote implements Stream so that note events can be retrieved asynchronously via it.

pub fn channel<R>(
    &self,
    request: R
) -> Pin<Box<dyn Future<Output = Result<Channel<<R as ConnectChannelRequest>::Incoming, <R as ConnectChannelRequest>::Outgoing>, Error>> + Send + 'static, Global>> where
    R: ConnectChannelRequest, 

Connects to the channel using request.

The returned Channel implements Stream and Sink so that you can exchange messages with channels on it.

pub fn broadcast<E>(
    &self
) -> Pin<Box<dyn Future<Output = Result<Broadcast<E>, Error>> + Send + 'static, Global>> where
    E: BroadcastEvent, 

Receive messages from the broadcast stream.

The returned Broadcast implements Stream so that broadcast events can be retrieved asynchronously via it.

Trait Implementations

impl Client for WebSocketClient

type Error = Error

The error type produced by the client when an error occurs.

fn request<R>(
    &self,
    request: R
) -> Pin<Box<dyn Future<Output = Result<ApiResult<<R as Request>::Response>, Error>> + Send, Global>> where
    R: Request, 

Dispatch an API request.

impl Clone for WebSocketClient

fn clone(&self) -> WebSocketClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketClient

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

Formats the value using the given formatter.

impl StreamingClient for WebSocketClient

type Error = Error

The error type produced by the client when an error occurs.

fn subnote<E>(
    &self,
    note_id: String
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<E, Error>> + Send, Global>>, Error>> + Send, Global>> where
    E: SubNoteEvent, 

Captures the note specified by note_id.

fn channel<R>(
    &self,
    request: R
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn StreamSink<<R as ConnectChannelRequest>::Incoming, <R as ConnectChannelRequest>::Outgoing, Error, Error = Error, Item = Result<<R as ConnectChannelRequest>::Incoming, Error>> + Send, Global>>, Error>> + Send, Global>> where
    R: ConnectChannelRequest, 

Connects to the channel using request.

fn broadcast<E>(
    &self
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<E, Error>> + Send, Global>>, Error>> + Send, Global>> where
    E: BroadcastEvent, 

Receive messages from the broadcast stream.