Struct EventCollector

pub struct EventCollector { /* private fields */ }

👎Deprecated: prefer the stand-alone collect() function to collect arbitrary events

A EventCollector receives Event’s match the given filters for a set duration.

Implementations

impl EventCollector

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(&Event) -> bool + Send + Sync + 'static, ) -> Self

Sets a generic filter function.

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

Returns a Stream over all collected Event.

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

👎Deprecated: use .stream() instead

Deprecated, use Self::stream() instead.

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

Returns the next Event which passes the filters. You can also call .await on the EventCollector directly.

Trait Implementations

impl IntoFuture for EventCollector

type Output = Option<Event>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <EventCollector 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.