Struct serenity::model::guild::MembersIter

pub struct MembersIter<H: AsRef<Http>> { /* fields omitted */ }

A helper class returned by GuildId.members_iter()

Implementations

impl<H: AsRef<Http>> MembersIter<H>

pub fn stream(
    http: impl AsRef<Http>,
    guild_id: GuildId
) -> impl Stream<Item = Result<Member>>

Streams over all the members in a guild.

This is accomplished and equivilent to repeated calls to members. A buffer of at most 1,000 members is used to reduce the number of calls necessary.

Examples

use serenity::model::guild::MembersIter;
use serenity::futures::StreamExt;

let mut members = MembersIter::<Http>::stream(&ctx, guild_id).boxed();
while let Some(member_result) = members.next().await {
    match member_result {
        Ok(member) => println!(
            "{} is {}",
            member,
            member.display_name(),
        ),
        Err(error) => eprintln!("Uh oh!  Error: {}", error),
    }
}

Trait Implementations

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

pub fn clone(&self) -> MembersIter<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.