Struct serenity::collector::reaction_collector::ReactionCollectorBuilder[−][src]

pub struct ReactionCollectorBuilder<'a> { /* fields omitted */ }
This is supported on crate feature collector only.

Implementations

impl<'a> ReactionCollectorBuilder<'a>[src]

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

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 collect_limit(self, limit: u32) -> Self[src]

Limits how many reactions can be collected.

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

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

Sets a filter function where reactions passed to the function must return true, otherwise the reaction won’t be collected. This is the last instance to pass for a reaction to count as collected.

This function is intended to be a reaction content filter.

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

Sets the required author ID of a reaction. If a reaction is not issued by a user with this ID, it won’t be received.

pub fn message_id(self, message_id: impl Into<u64>) -> Self[src]

Sets the message on which the reaction must occur. If a reaction is not on a message with this ID, it won’t be received.

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

Sets the guild in which the reaction must occur. If a reaction is not on a message with this guild ID, it won’t be received.

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

Sets the channel on which the reaction must occur. If a reaction is not on a message with this channel ID, it won’t be received.

pub fn added(self, is_accepted: bool) -> Self[src]

If set to true, added reactions will be collected.

Set to true by default.

pub fn removed(self, is_accepted: bool) -> Self[src]

If set to true, removed reactions will be collected.

Set to false by default.

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

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

impl<'a> ReactionCollectorBuilder<'a>[src]

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

Trait Implementations

impl<'a> Future for ReactionCollectorBuilder<'a>[src]

type Output = ReactionCollector

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut FutContext<'_>) -> Poll<Self::Output>[src]

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> FutureExt for T where
    T: Future + ?Sized, 

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output) -> U, 

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn map_into<U>(self) -> MapInto<Self, U> where
    Self::Output: Into<U>, 

Map this future’s output to a different type, returning a new future of the resulting type. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

fn left_future<B>(self) -> Either<Self, B> where
    B: Future<Output = Self::Output>, 

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

fn right_future<A>(self) -> Either<A, Self> where
    A: Future<Output = Self::Output>, 

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Output: Future, 

Flatten the execution of this future when the output of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Output: Stream, 

Flatten the execution of this future when the successful result of this future is a stream. Read more

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Output), 

Do something with the output of a future before passing it on. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future. Read more

fn shared(self) -> Shared<Self> where
    Self::Output: Clone, 

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
    Self: Send + 'a, 

Wrap the future in a Box, pinning it. Read more

fn boxed_local<'a>(
    self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
    Self: 'a, 

Wrap the future in a Box, pinning it. Read more

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
    Self: Unpin, 

A convenience for calling Future::poll on Unpin future types.

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<F> IntoFuture for F where
    F: Future, [src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

pub fn into_future(self) -> <F as IntoFuture>::Future[src]

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V