Struct serenity::collector::message_collector::CollectReply

source · [−]

pub struct CollectReply { /* private fields */ }

Available on crate feature collector only.

Implementations

source

impl CollectReply

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

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

source

impl CollectReply

source

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

Trait Implementations

source

impl Future for CollectReply

type Output = Option<Arc<Message>>

The type of value produced on completion.

source

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

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

impl !RefUnwindSafe for CollectReply

impl Send for CollectReply

impl !Sync for CollectReply

impl Unpin for CollectReply

impl !UnwindSafe for CollectReply

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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(self) -> MapInto<Self, U> where
Self::Output: Into,

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(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,

Available on crate feature std only.

Catches unwinding panics while polling the future. Read more

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

Available on crate feature std only.

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>)

Available on crate features channel and std only.

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> + Send + 'a, Global>> where
Self: 'a + Send,

Available on crate feature alloc only.

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,

Available on crate feature alloc only.

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

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>

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

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<F> IntoFuture for F where
F: Future,

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 IntoFuture = F

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

Which kind of future are we turning this into?

source

fn into_future(self) -> <F as IntoFuture>::IntoFuture

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

Creates a future from a value.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct serenity::collector::message_collector::CollectReply

Implementations

impl CollectReply

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

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

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

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

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

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

impl CollectReply

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

Trait Implementations

impl Future for CollectReply

type Output = Option<Arc<Message>>

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

Auto Trait Implementations

impl !RefUnwindSafe for CollectReply

impl Send for CollectReply

impl !Sync for CollectReply

impl Unpin for CollectReply

impl !UnwindSafe for CollectReply

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

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,

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

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

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

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

fn into_stream(self) -> IntoStream<Self>

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

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

fn fuse(self) -> Fuse<Self>

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

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

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

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

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

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

fn unit_error(self) -> UnitError<Self>

fn never_error(self) -> NeverError<Self>

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

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

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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,

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

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

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

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

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

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

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

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

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

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

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

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<F> IntoFuture for F where
F: Future,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,