Struct serenity::collector::message_collector::MessageCollectorBuilder

pub struct MessageCollectorBuilder { /* private fields */ }

Available on crate feature collector only.

Future building a stream of messages.

Implementations

impl MessageCollectorBuilder

pub fn filter_limit(self, limit: u32) -> Self

Limits how many messages will attempt to be filtered.

The filter checks whether the message has been sent in the right guild, channel, and by the right author.

pub fn filter<F: Fn(&Arc<Message>) -> bool + 'static + Send + Sync>(
    self,
    function: F
) -> Self

Sets a filter function where messages passed to the function must return true, otherwise the message won’t be collected and failed the filter process. This is the last instance to pass for a message to count as collected.

This function is intended to be a message content filter.

pub fn author_id(self, author_id: impl Into<u64>) -> Self

Sets the required author ID of a message. If a message does not meet this ID, it won’t be received.

pub fn channel_id(self, channel_id: impl Into<u64>) -> Self

Sets the required channel ID of a message. If a message does not meet this ID, it won’t be received.

pub fn guild_id(self, guild_id: impl Into<u64>) -> Self

Sets the required guild ID of a message. If a message does not meet this ID, it won’t be received.

pub fn timeout(self, duration: Duration) -> Self

Sets a duration for how long the collector shall receive messages.

impl MessageCollectorBuilder

pub fn new(shard_messenger: impl AsRef<ShardMessenger>) -> Self

A future that builds a MessageCollector based on the settings.

pub fn collect_limit(self, limit: u32) -> Self

Limits how many messages can be collected.

A message is considered collected, if the message passes all the requirements.

pub fn build(self) -> MessageCollector

Use the given configuration to build the MessageCollector.