[−][src]Struct serenity::collector::message_collector::MessageCollectorBuilder
Future building a stream of messages.
Implementations
impl<'a> MessageCollectorBuilder<'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 filter<F: Fn(&Arc<Message>) -> bool + 'static + Send + Sync>(
self,
function: F
) -> Self
[src]
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
[src]
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
[src]
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
[src]
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
[src]
Sets a duration
for how long the collector shall receive
messages.
impl<'a> MessageCollectorBuilder<'a>
[src]
pub fn new(shard_messenger: impl AsRef<ShardMessenger>) -> Self
[src]
A future that builds a MessageCollector
based on the settings.
pub fn collect_limit(self, limit: u32) -> Self
[src]
Limits how many messages can be collected.
A message is considered collected, if the message passes all the requirements.
Trait Implementations
impl<'a> Future for MessageCollectorBuilder<'a>
[src]
type Output = MessageCollector
The type of value produced on completion.
pub fn poll(
self: Pin<&mut Self>,
ctx: &mut FutContext<'_>
) -> Poll<Self::Output>
[src]
self: Pin<&mut Self>,
ctx: &mut FutContext<'_>
) -> Poll<Self::Output>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for MessageCollectorBuilder<'a>
[src]
impl<'a> Send for MessageCollectorBuilder<'a>
[src]
impl<'a> !Sync for MessageCollectorBuilder<'a>
[src]
impl<'a> Unpin for MessageCollectorBuilder<'a>
[src]
impl<'a> !UnwindSafe for MessageCollectorBuilder<'a>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> FutureExt for T where
T: Future + ?Sized,
[src]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
[src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>,
[src]
Self::Output: Into<U>,
pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
[src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
[src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
[src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>
[src]
pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
[src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
[src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>
[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
[src]
F: FnOnce(&Self::Output),
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
[src]
Self: UnwindSafe,
pub fn shared(self) -> Shared<Self> where
Self::Output: Clone,
[src]
Self::Output: Clone,
pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)
[src]
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
[src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
[src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
pub fn unit_error(self) -> UnitError<Self>
[src]
pub fn never_error(self) -> NeverError<Self>
[src]
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
[src]
Self: Unpin,
pub fn now_or_never(self) -> Option<Self::Output>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
into_future
)The output that the future will produce on completion.
type Future = F
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
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]
U: Into<T>,
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]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
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]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,