Struct async_std::stream::Interval

source ·

pub struct Interval { /* private fields */ }

Expand description

A stream representing notifications at fixed interval

This stream is created by the interval function. See its documentation for more.

Trait Implementations§

source §

impl Debug for Interval

source §

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

Formats the value using the given formatter. Read more

source §

impl Stream for Interval

§

type Item = ()

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

source §

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

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

Auto Trait Implementations§

§

impl UnwindSafe for Interval

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, U> Into 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<S> StreamExt for Swhere
S: Stream + ?Sized,

source §

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

A convenience for calling Stream::poll_next() on !Unpin types.

source §

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

Retrieves the next item in the stream. Read more

source §

fn try_next<T, E>(&mut self) -> TryNextFuture<'_, Self> ⓘwhere
Self: Stream<Item = Result<T, E>> + Unpin,

Retrieves the next item in the stream. Read more

source §

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

Counts the number of items in the stream. Read more

source §

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

Maps items of the stream to new values using a closure. Read more

source §

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

Maps items to streams and then concatenates them. Read more

source §

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

Concatenates inner streams. Read more

source §

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

Maps items of the stream to new values using an async closure. Read more

source §

fn filter(self, predicate: P) -> Filter<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Keeps items of the stream for which predicate returns true. Read more

source §

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

Filters and maps items of the stream using a closure. Read more

source §

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

Takes only the first n items of the stream. Read more

source §

fn take_while(self, predicate: P) -> TakeWhile<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Takes items while predicate returns true. Read more

source §

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

Skips the first n items of the stream. Read more

source §

fn skip_while(self, predicate: P) -> SkipWhile<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

Skips items while predicate returns true. Read more

source §

fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,

Yields every stepth item. Read more

source §

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

Appends another stream to the end of this one. Read more

source §

fn cloned<'a, T>(self) -> Cloned<Self>where
Self: Stream<Item = &'a T> + Sized,
T: 'a + Clone,

Clones all items. Read more

source §

fn copied<'a, T>(self) -> Copied<Self>where
Self: Stream<Item = &'a T> + Sized,
T: 'a + Copy,

Copies all items. Read more

source §

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

Collects all items in the stream into a collection. Read more

source §

fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C> ⓘwhere
Self: Stream<Item = Result<T, E>> + Sized,
C: Default + Extend<T>,

Collects all items in the fallible stream into a collection. Read more

source §

fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B> ⓘwhere
 Self: Sized,
 B: Default + Extend<Self::Item>,
 P: FnMut(&Self::Item) -> bool,

Partitions items into those for which predicate is true and those for which it is false, and then collects them into two collections. Read more

source §

fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T> ⓘwhere
Self: Sized,
F: FnMut(T, Self::Item) -> T,

Accumulates a computation over the stream. Read more

source §

fn try_fold<T, E, F, B>(&mut self, init: B, f: F) -> TryFoldFuture<'_, Self, F, B> ⓘwhere
Self: Stream<Item = Result<T, E>> + Unpin + Sized,
F: FnMut(B, T) -> Result<B, E>,

Accumulates a fallible computation over the stream. Read more

source §

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>where
Self: Sized,
F: FnMut(&mut St, Self::Item) -> Option,

Maps items of the stream to new values using a state value and a closure. Read more

source §

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

Fuses the stream so that it stops yielding items after the first None. Read more

source §

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

Repeats the stream from beginning to end, forever. Read more

source §

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

Enumerates items, mapping them to (index, item). Read more

source §

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

Calls a closure on each item and passes it on. Read more

source §

fn nth(&mut self, n: usize) -> NthFuture<'_, Self> ⓘwhere
Self: Unpin,

Gets the nth item of the stream. Read more

source §

fn last(self) -> LastFuture<Self> ⓘwhere
Self: Sized,

Returns the last item in the stream. Read more

source §

fn find(&mut self, predicate: P) -> FindFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(&Self::Item) -> bool,

Finds the first item of the stream for which predicate returns true. Read more

source §

fn find_map<F, B>(&mut self, f: F) -> FindMapFuture<'_, Self, F> ⓘwhere
Self: Unpin,
F: FnMut(Self::Item) -> Option,

Applies a closure to items in the stream and returns the first Some result. Read more

source §

fn position(&mut self, predicate: P) -> PositionFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(Self::Item) -> bool,

Finds the index of the first item of the stream for which predicate returns true. Read more

source §

fn all(&mut self, predicate: P) -> AllFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(Self::Item) -> bool,

Tests if predicate returns true for all items in the stream. Read more

source §

fn any(&mut self, predicate: P) -> AnyFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(Self::Item) -> bool,

Tests if predicate returns true for any item in the stream. Read more

source §

fn for_each<F>(self, f: F) -> ForEachFuture<Self, F> ⓘwhere
Self: Sized,
F: FnMut(Self::Item),

Calls a closure on each item of the stream. Read more

source §

fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F> ⓘwhere
Self: Unpin,
F: FnMut(Self::Item) -> Result<(), E>,

Calls a fallible closure on each item of the stream, stopping on first error. Read more

source §

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

Zips up two streams into a single stream of pairs. Read more

source §

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

Collects a stream of pairs into a pair of collections. Read more

source §

fn or<S>(self, other: S) -> Or<Self, S>where
Self: Sized,
S: Stream<Item = Self::Item>,

Merges with other stream, preferring items from self whenever both streams are ready. Read more

source §

fn race<S>(self, other: S) -> Race<Self, S>where
Self: Sized,
S: Stream<Item = Self::Item>,

Merges with other stream, with no preference for either stream when both are ready. Read more

source §

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

Boxes the stream and changes its type to dyn Stream + Send + 'a. Read more

source §

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

Boxes the stream and changes its type to dyn Stream + 'a. Read more

source §

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

Performs the conversion.

source §

impl<T, U> TryInto for Twhere
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.

Struct async_std::stream::Interval

Trait Implementations§

impl Debug for Interval

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

impl Stream for Interval

type Item = ()

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

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

Auto Trait Implementations§

impl RefUnwindSafe for Interval

impl Send for Interval

impl Sync for Interval

impl Unpin for Interval

impl UnwindSafe for Interval

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<S> StreamExt for Swhere S: Stream + ?Sized,

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

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

fn try_next<T, E>(&mut self) -> TryNextFuture<'_, Self> ⓘwhere Self: Stream<Item = Result<T, E>> + Unpin,

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

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

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

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

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

fn filter<P>(self, predicate: P) -> Filter<Self, P>where Self: Sized, P: FnMut(&Self::Item) -> bool,

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

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

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>where Self: Sized, P: FnMut(&Self::Item) -> bool,

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

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>where Self: Sized, P: FnMut(&Self::Item) -> bool,

fn step_by(self, step: usize) -> StepBy<Self>where Self: Sized,

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

fn cloned<'a, T>(self) -> Cloned<Self>where Self: Stream<Item = &'a T> + Sized, T: 'a + Clone,

fn copied<'a, T>(self) -> Copied<Self>where Self: Stream<Item = &'a T> + Sized, T: 'a + Copy,

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

fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C> ⓘwhere Self: Stream<Item = Result<T, E>> + Sized, C: Default + Extend<T>,

fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B> ⓘwhere Self: Sized, B: Default + Extend<Self::Item>, P: FnMut(&Self::Item) -> bool,

fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T> ⓘwhere Self: Sized, F: FnMut(T, Self::Item) -> T,

fn try_fold<T, E, F, B>(&mut self, init: B, f: F) -> TryFoldFuture<'_, Self, F, B> ⓘwhere Self: Stream<Item = Result<T, E>> + Unpin + Sized, F: FnMut(B, T) -> Result<B, E>,

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

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

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

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

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

fn nth(&mut self, n: usize) -> NthFuture<'_, Self> ⓘwhere Self: Unpin,

fn last(self) -> LastFuture<Self> ⓘwhere Self: Sized,

fn find<P>(&mut self, predicate: P) -> FindFuture<'_, Self, P> ⓘwhere Self: Unpin, P: FnMut(&Self::Item) -> bool,

fn find_map<F, B>(&mut self, f: F) -> FindMapFuture<'_, Self, F> ⓘwhere Self: Unpin, F: FnMut(Self::Item) -> Option<B>,

fn position<P>(&mut self, predicate: P) -> PositionFuture<'_, Self, P> ⓘwhere Self: Unpin, P: FnMut(Self::Item) -> bool,

fn all<P>(&mut self, predicate: P) -> AllFuture<'_, Self, P> ⓘwhere Self: Unpin, P: FnMut(Self::Item) -> bool,

fn any<P>(&mut self, predicate: P) -> AnyFuture<'_, Self, P> ⓘwhere Self: Unpin, P: FnMut(Self::Item) -> bool,

fn for_each<F>(self, f: F) -> ForEachFuture<Self, F> ⓘwhere Self: Sized, F: FnMut(Self::Item),

fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F> ⓘwhere Self: Unpin, F: FnMut(Self::Item) -> Result<(), E>,

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

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

fn or<S>(self, other: S) -> Or<Self, S>where Self: Sized, S: Stream<Item = Self::Item>,

fn race<S>(self, other: S) -> Race<Self, S>where Self: Sized, S: Stream<Item = Self::Item>,

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

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

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

impl<S> StreamExt for Swhere
S: Stream + ?Sized,

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

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

fn try_next<T, E>(&mut self) -> TryNextFuture<'_, Self> ⓘwhere
Self: Stream<Item = Result<T, E>> + Unpin,

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

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

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

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

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

fn filter<P>(self, predicate: P) -> Filter<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

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

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

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

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

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,

fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,

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

fn cloned<'a, T>(self) -> Cloned<Self>where
Self: Stream<Item = &'a T> + Sized,
T: 'a + Clone,

fn copied<'a, T>(self) -> Copied<Self>where
Self: Stream<Item = &'a T> + Sized,
T: 'a + Copy,

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

fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C> ⓘwhere
Self: Stream<Item = Result<T, E>> + Sized,
C: Default + Extend<T>,

fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B> ⓘwhere
Self: Sized,
B: Default + Extend<Self::Item>,
P: FnMut(&Self::Item) -> bool,

fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T> ⓘwhere
Self: Sized,
F: FnMut(T, Self::Item) -> T,

fn try_fold<T, E, F, B>(&mut self, init: B, f: F) -> TryFoldFuture<'_, Self, F, B> ⓘwhere
Self: Stream<Item = Result<T, E>> + Unpin + Sized,
F: FnMut(B, T) -> Result<B, E>,

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>where
Self: Sized,
F: FnMut(&mut St, Self::Item) -> Option<B>,

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

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

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

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

fn nth(&mut self, n: usize) -> NthFuture<'_, Self> ⓘwhere
Self: Unpin,

fn last(self) -> LastFuture<Self> ⓘwhere
Self: Sized,

fn find<P>(&mut self, predicate: P) -> FindFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(&Self::Item) -> bool,

fn find_map<F, B>(&mut self, f: F) -> FindMapFuture<'_, Self, F> ⓘwhere
Self: Unpin,
F: FnMut(Self::Item) -> Option<B>,

fn position<P>(&mut self, predicate: P) -> PositionFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(Self::Item) -> bool,

fn all<P>(&mut self, predicate: P) -> AllFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(Self::Item) -> bool,

fn any<P>(&mut self, predicate: P) -> AnyFuture<'_, Self, P> ⓘwhere
Self: Unpin,
P: FnMut(Self::Item) -> bool,

fn for_each<F>(self, f: F) -> ForEachFuture<Self, F> ⓘwhere
Self: Sized,
F: FnMut(Self::Item),

fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F> ⓘwhere
Self: Unpin,
F: FnMut(Self::Item) -> Result<(), E>,

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

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

fn or<S>(self, other: S) -> Or<Self, S>where
Self: Sized,
S: Stream<Item = Self::Item>,

fn race<S>(self, other: S) -> Race<Self, S>where
Self: Sized,
S: Stream<Item = Self::Item>,

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

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

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

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