Struct serenity::model::channel::MessagesIter

pub struct MessagesIter<H: AsRef<Http>> { /* private fields */ }

Available on crate feature model only.

A helper class returned by ChannelId::messages_iter

Implementations

impl<H: AsRef<Http>> MessagesIter<H>

pub fn stream(
    http: impl AsRef<Http>,
    channel_id: ChannelId
) -> impl Stream<Item = Result<Message>>

Streams over all the messages in a channel.

This is accomplished and equivalent to repeated calls to ChannelId::messages. A buffer of at most 100 messages is used to reduce the number of calls. necessary.

The stream returns the newest message first, followed by older messages.

Examples

use serenity::futures::StreamExt;
use serenity::model::channel::MessagesIter;

let mut messages = MessagesIter::<Http>::stream(&ctx, channel_id).boxed();
while let Some(message_result) = messages.next().await {
    match message_result {
        Ok(message) => println!("{} said \"{}\"", message.author.name, message.content,),
        Err(error) => eprintln!("Uh oh! Error: {}", error),
    }
}

Trait Implementations

impl<H: Clone + AsRef<Http>> Clone for MessagesIter<H>

fn clone(&self) -> MessagesIter<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug + AsRef<Http>> Debug for MessagesIter<H>

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

Formats the value using the given formatter.