Trait misskey::prelude::StreamingClient

pub trait StreamingClient {
    type Error: Error;
    pub fn subnote<E>(
        &self, 
        note_id: String
    ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<E, Self::Error>> + Send, Global>>, Self::Error>> + Send, Global>>
    where
        E: SubNoteEvent;
    pub fn channel<R>(
        &self, 
        request: R
    ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn StreamSink<<R as ConnectChannelRequest>::Incoming, <R as ConnectChannelRequest>::Outgoing, Self::Error, Item = Result<<R as ConnectChannelRequest>::Incoming, Self::Error>, Error = Self::Error> + Send, Global>>, Self::Error>> + Send, Global>>
    where
        R: ConnectChannelRequest;
    pub fn broadcast<E>(
        &self
    ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<E, Self::Error>> + Send, Global>>, Self::Error>> + Send, Global>>
    where
        E: BroadcastEvent;
}

Abstraction over API clients with streaming connections.

Associated Types

type Error: Error

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

Loading content...

Required methods

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

Captures the note specified by note_id.

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

Connects to the channel using request.

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

Receive messages from the broadcast stream.

Loading content...

Implementations on Foreign Types

impl<C> StreamingClient for Box<C, Global> where
    C: StreamingClient + ?Sized, 

type Error = <C as StreamingClient>::Error

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

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

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

impl<'_, C> StreamingClient for &'_ mut C where
    C: StreamingClient + ?Sized, 

type Error = <C as StreamingClient>::Error

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

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

pub fn broadcast<E>(
    &self
) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Result<E, <&'_ mut C as StreamingClient>::Error>> + Send, Global>>, <&'_ mut C as StreamingClient>::Error>> + Send, Global>> where
    E: BroadcastEvent, 

impl<'_, C> StreamingClient for &'_ C where
    C: StreamingClient + ?Sized, 

type Error = <C as StreamingClient>::Error

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

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

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

Loading content...

Implementors

impl StreamingClient for WebSocketClient

type Error = Error

pub 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, 

pub 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, Item = Result<<R as ConnectChannelRequest>::Incoming, Error>, Error = Error> + Send, Global>>, Error>> + Send, Global>> where
    R: ConnectChannelRequest, 

pub 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, 

Loading content...