Struct ComponentInteractionCollector

pub struct ComponentInteractionCollector { /* private fields */ }

A ComponentInteractionCollector receives ComponentInteraction’s match the given filters for a set duration.

Implementations

impl ComponentInteractionCollector

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

Creates a new collector without any filters configured.

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

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

pub fn filter( self, filter: impl Fn(&ComponentInteraction) -> bool + Send + Sync + 'static, ) -> Self

Sets a generic filter function.

pub fn author_id(self, author_id: UserId) -> Self

Filters ComponentInteraction’s by a specific UserId.

pub fn channel_id(self, channel_id: ChannelId) -> Self

Filters ComponentInteraction’s by a specific ChannelId.

pub fn guild_id(self, guild_id: GuildId) -> Self

Filters ComponentInteraction’s by a specific GuildId.

pub fn message_id(self, message_id: MessageId) -> Self

Filters ComponentInteraction’s by a specific MessageId.

pub fn custom_ids(self, custom_ids: Vec<String>) -> Self

Filters ComponentInteraction’s by a specific Vec<String>.

pub fn stream(self) -> impl Stream<Item = ComponentInteraction>

Returns a Stream over all collected ComponentInteraction.

pub fn build(self) -> impl Stream<Item = ComponentInteraction>

👎Deprecated: use .stream() instead

Deprecated, use Self::stream() instead.

pub async fn next(self) -> Option<ComponentInteraction>

Returns the next ComponentInteraction which passes the filters. You can also call .await on the ComponentInteractionCollector directly.

Trait Implementations

impl IntoFuture for ComponentInteractionCollector

type Output = Option<ComponentInteraction>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <ComponentInteractionCollector as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.