Struct twilight_gateway::shard::Events

source · 
pub struct Events { /* private fields */ }
Expand description

A stream of events from a Shard.

The events of this stream may or may not be filtered. You can check the event types returned by Events::event_types to see what events can come in through this stream.

This implements futures::stream::Stream.

Examples

Refer to Shard for an example of how to use this.

Implementations§

source§

impl Events

source

pub const fn event_types(&self) -> EventTypeFlags

Returns the event types that can be passed to this stream.

Trait Implementations§

source§

impl Debug for Events

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Stream for Events

§

type Item = Event

Values yielded by the stream.
source§

fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more
§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Events

§

impl Send for Events

§

impl Sync for Events

§

impl Unpin for Events

§

impl !UnwindSafe for Events

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
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.

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<U> for Twhere
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<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> StreamExt for Twhere
T: Stream + ?Sized,

source§

fn next(&mut self) -> Next<'_, Self>where
Self: Unpin,

Creates a future that resolves to the next item in the stream. Read more
source§

fn into_future(self) -> StreamFuture<Self>where
Self: Sized + Unpin,

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is None. Read more
source§

fn map<T, F>(self, f: F) -> Map<Self, F>where
F: FnMut(Self::Item) -> T,
Self: Sized,

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more
source§

fn enumerate(self) -> Enumerate<Self>where
Self: Sized,

Creates a stream which gives the current iteration count as well as the next value. Read more
source§

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
Self: Sized,

Filters the values produced by this stream according to the provided asynchronous predicate. Read more
source§

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = Option<T>>,
Self: Sized,

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more
source§

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future,
Self: Sized,

Computes from this stream’s items new items of a different type using an asynchronous closure. Read more
source§

fn collect<C>(self) -> Collect<Self, C>where
C: Default + Extend<Self::Item>,
Self: Sized,

Transforms a stream into a collection, returning a future representing the result of that computation. Read more
source§

fn unzip<A, B, FromA, FromB>(self) -> Unzip<Self, FromA, FromB>where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Sized + Stream<Item = (A, B)>,

Converts a stream of pairs into a future, which resolves to pair of containers. Read more
source§

fn concat(self) -> Concat<Self>where
Self: Sized,
Self::Item: Extend<<Self::Item as IntoIterator>::Item> + IntoIterator + Default,

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more
source§

fn count(self) -> Count<Self>where
Self: Sized,

Drives the stream to completion, counting the number of items. Read more
source§

fn cycle(self) -> Cycle<Self>where
Self: Sized + Clone,

Repeats a stream endlessly. Read more
source§

fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F>where
F: FnMut(T, Self::Item) -> Fut,
Fut: Future<Output = T>,
Self: Sized,

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more
source§

fn any<Fut, F>(self, f: F) -> Any<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,
Self: Sized,

Execute predicate over asynchronous stream, and return true if any element in stream satisfied a predicate. Read more
source§

fn all<Fut, F>(self, f: F) -> All<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = bool>,
Self: Sized,

Execute predicate over asynchronous stream, and return true if all element in stream satisfied a predicate. Read more
source§

fn flatten(self) -> Flatten<Self>where
Self::Item: Stream,
Self: Sized,

Flattens a stream of streams into just one continuous stream. Read more
source§

fn flatten_unordered(
self,
limit: impl Into<Option<usize>>
) -> FlattenUnordered<Self>where
Self::Item: Stream + Unpin,
Self: Sized,

Flattens a stream of streams into just one continuous stream. Polls inner streams concurrently. Read more
source§

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>where
F: FnMut(Self::Item) -> U,
U: Stream,
Self: Sized,

Maps a stream like StreamExt::map but flattens nested Streams. Read more
source§

fn flat_map_unordered<U, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> FlatMapUnordered<Self, U, F>where
U: Stream + Unpin,
F: FnMut(Self::Item) -> U,
Self: Sized,

Maps a stream like StreamExt::map but flattens nested Streams and polls them concurrently, yielding items in any order, as they made available. Read more
source§

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F>where
F: FnMut(&mut S, Self::Item) -> Fut,
Fut: Future<Output = Option<B>>,
Self: Sized,

Combinator similar to StreamExt::fold that holds internal state and produces a new stream. Read more
source§

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
Self: Sized,

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more
source§

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F>where
F: FnMut(&Self::Item) -> Fut,
Fut: Future<Output = bool>,
Self: Sized,

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more
source§

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut>where
Fut: Future,
Self: Sized,

Take elements from this stream until the provided future resolves. Read more
source§

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
Self: Sized,

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more
source§

fn for_each_concurrent<Fut, F>(
self,
limit: impl Into<Option<usize>>,
f: F
) -> ForEachConcurrent<Self, Fut, F>where
F: FnMut(Self::Item) -> Fut,
Fut: Future<Output = ()>,
Self: Sized,

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more
source§

fn take(self, n: usize) -> Take<Self>where
Self: Sized,

Creates a new stream of at most n items of the underlying stream. Read more
source§

fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,

Creates a new stream which skips n items of the underlying stream. Read more
source§

fn fuse(self) -> Fuse<Self>where
Self: Sized,

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used to turn any Stream into a FusedStream. Read more
source§

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it. Read more
source§

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

Catches unwinding panics while polling the stream. Read more
source§

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

Wrap the stream in a Box, pinning it. Read more
source§

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

Wrap the stream in a Box, pinning it. Read more
source§

fn buffered(self, n: usize) -> Buffered<Self>where
Self::Item: Future,
Self: Sized,

An adaptor for creating a buffered list of pending futures. Read more
source§

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self>where
Self::Item: Future,
Self: Sized,

An adaptor for creating a buffered list of pending futures (unordered). Read more
source§

fn zip<St>(self, other: St) -> Zip<Self, St>where
St: Stream,
Self: Sized,

An adapter for zipping two streams together. Read more
source§

fn chain<St>(self, other: St) -> Chain<Self, St>where
St: Stream<Item = Self::Item>,
Self: Sized,

Adapter for chaining two streams. Read more
source§

fn peekable(self) -> Peekable<Self>where
Self: Sized,

Creates a new stream which exposes a peek method. Read more
source§

fn chunks(self, capacity: usize) -> Chunks<Self>where
Self: Sized,

An adaptor for chunking up items of the stream inside a vector. Read more
source§

fn ready_chunks(self, capacity: usize) -> ReadyChunks<Self>where
Self: Sized,

An adaptor for chunking up ready items of the stream inside a vector. Read more
source§

fn forward<S>(self, sink: S) -> Forward<Self, S>where
S: Sink<Self::Ok, Error = Self::Error>,
Self: TryStream + Sized,

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more
source§

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>)where
Self: Sink<Item> + Sized,

Splits this Stream + Sink object into separate Sink and Stream objects. Read more
source§

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnMut(&Self::Item),
Self: Sized,

Do something with each item of this stream, afterwards passing it on. Read more
source§

fn left_stream<B>(self) -> Either<Self, B>where
B: Stream<Item = Self::Item>,
Self: Sized,

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

fn right_stream<B>(self) -> Either<B, Self>where
B: Stream<Item = Self::Item>,
Self: Sized,

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

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>>where
Self: Unpin,

A convenience method for calling [Stream::poll_next] on Unpin stream types.
source§

fn select_next_some(&mut self) -> SelectNextSome<'_, Self>where
Self: Unpin + FusedStream,

Returns a Future that resolves when the next item in this stream is ready. Read more
source§

impl<T, U> TryFrom<U> for Twhere
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<U>>::Error>

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere
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