Struct showdown::Stream

pub struct Stream { /* fields omitted */ }

Message stream.

Examples

use futures::{SinkExt, StreamExt};
use showdown::message::{Kind, UpdateUser};
use showdown::{connect, Result, RoomId};

#[tokio::main]
async fn main() -> Result<()> {
    let mut stream = connect("showdown").await?;
    let message = stream.next().await.unwrap()?;
    match message.kind() {
        Kind::UpdateUser(UpdateUser {
            username,
            named: false,
            ..
        }) => {
            assert!(username.starts_with(" Guest "));
        }
        _ => panic!(),
    }
    Ok(())
}

Trait Implementations

impl Debug for Stream

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

Formats the value using the given formatter.

impl Sink<SendMessage> for Stream

type Error = Error

The type of value produced by the sink when an error occurs.

pub fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<()>>

Attempts to prepare the Sink to receive a value.

pub fn start_send(self: Pin<&mut Self>, item: SendMessage) -> Result<()>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

pub fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<()>>

Flush any remaining output from this sink.

pub fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<()>>

Flush any remaining output and close this sink, if necessary.

impl Stream for Stream

type Item = Result<Message>

Values yielded by the stream.

pub fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.