Struct PermitIterator
pub struct PermitIterator<'a, T> { /* private fields */ }
Available on crate feature
sync only.An Iterator of Permit that can be used to hold n slots in the channel.
PermitIterator values are returned by Sender::reserve_many() and Sender::try_reserve_many() and are used to guarantee channel capacity before generating n messages to send.
Trait Implementations
impl<T> Debug for PermitIterator<'_, T>
impl<T> Drop for PermitIterator<'_, T>
impl<T> ExactSizeIterator for PermitIterator<'_, T>
impl<T> FusedIterator for PermitIterator<'_, T>
impl<'a, T> Iterator for PermitIterator<'a, T>
fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator. Read more
fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where Self: Sized,
🔬This is a nightly-only experimental API. (
iter_next_chunk)
Advances the iterator and returns an array containing the next
N values. Read more
fn count(self) -> usizewhere Self: Sized,
Consumes the iterator, counting the number of iterations and returning it. Read more
fn last(self) -> Option<Self::Item>where Self: Sized,
Consumes the iterator, returning the last element. Read more
fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
🔬This is a nightly-only experimental API. (
iter_advance_by)
Advances the iterator by
n elements. Read more
fn nth(&mut self, n: usize) -> Option<Self::Item>
Returns the
nth element of the iterator. Read more
fn step_by(self, step: usize) -> StepBy<Self>where Self: Sized,
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
Takes two iterators and creates a new iterator over both in sequence. Read more
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where Self: Sized, U: IntoIterator,
‘Zips up’ two iterators into a single iterator of pairs. Read more
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
🔬This is a nightly-only experimental API. (
iter_intersperse)
Creates a new iterator which places an item generated by
separator between items of the original iterator. Read more
fn map<B, F>(self, f: F) -> Map<Self, F>
Takes a closure and creates an iterator which calls that closure on each element. Read more
fn for_each<F>(self, f: F)
Calls a closure on each element of an iterator. Read more
fn filter<P>(self, predicate: P) -> Filter<Self, P>
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
Creates an iterator that both filters and maps. Read more
fn enumerate(self) -> Enumerate<Self>where Self: Sized,
Creates an iterator which gives the current iteration count as well as the next value. Read more
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
Creates an iterator that yields elements based on a predicate. Read more
fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
Creates an iterator that both yields elements based on a predicate and maps. Read more
fn skip(self, n: usize) -> Skip<Self>where Self: Sized,
Creates an iterator that skips the first
n elements. Read more
fn take(self, n: usize) -> Take<Self>where Self: Sized,
Creates an iterator that yields the first
n elements, or fewer if the underlying iterator ends sooner. Read more
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
Creates an iterator that works like map, but flattens nested structure. Read more
fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
🔬This is a nightly-only experimental API. (
iter_map_windows)
Calls the given function
f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F>
Does something with each element of an iterator, passing the value on. Read more
fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,
Creates a “by reference” adapter for this instance of
Iterator. Read more
fn collect<B>(self) -> B
Transforms an iterator into a collection. Read more
fn collect_into<E>(self, collection: &mut E) -> &mut E
🔬This is a nightly-only experimental API. (
iter_collect_into)
Collects all the items from an iterator into a collection. Read more
fn partition<B, F>(self, f: F) -> (B, B)
Consumes an iterator, creating two collections from it. Read more
fn is_partitioned<P>(self, predicate: P) -> bool
🔬This is a nightly-only experimental API. (
iter_is_partitioned)
Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return
true precede all those that return false. Read more
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
fn try_for_each<F, R>(&mut self, f: F) -> R
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
fn fold<B, F>(self, init: B, f: F) -> B
Folds every element into an accumulator by applying an operation, returning the final result. Read more
fn reduce<F>(self, f: F) -> Option<Self::Item>
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
🔬This is a nightly-only experimental API. (
iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
fn all<F>(&mut self, f: F) -> bool
Tests if every element of the iterator matches a predicate. Read more
fn any<F>(&mut self, f: F) -> bool
Tests if any element of the iterator matches a predicate. Read more
fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
Searches for an element of an iterator that satisfies a predicate. Read more
fn find_map<B, F>(&mut self, f: F) -> Option<B>
Applies function to the elements of iterator and returns the first non-none result. Read more
fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
🔬This is a nightly-only experimental API. (
try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
fn position<P>(&mut self, predicate: P) -> Option<usize>
Searches for an element in an iterator, returning its index. Read more
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
Returns the element that gives the maximum value from the specified function. Read more
fn max_by<F>(self, compare: F) -> Option<Self::Item>
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
Returns the element that gives the minimum value from the specified function. Read more
fn min_by<F>(self, compare: F) -> Option<Self::Item>
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
Converts an iterator of pairs into a pair of containers. Read more
fn copied<'a, T>(self) -> Copied<Self>
Creates an iterator which copies all of its elements. Read more
fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where Self: Sized,
🔬This is a nightly-only experimental API. (
iter_array_chunks)
Returns an iterator over
N elements of the iterator at a time. Read more
fn product<P>(self) -> P
Iterates over the entire iterator, multiplying all the elements. Read more
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
🔬This is a nightly-only experimental API. (
iter_order_by)
Lexicographically compares the elements of this
Iterator with those of another with respect to the specified comparison function. Read more
fn partial_cmp<I>(self, other: I) -> Option<Ordering>
Lexicographically compares the
PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned. Read more
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
🔬This is a nightly-only experimental API. (
iter_order_by)
Lexicographically compares the elements of this
Iterator with those of another with respect to the specified comparison function. Read more
fn eq_by<I, F>(self, other: I, eq: F) -> bool
🔬This is a nightly-only experimental API. (
iter_order_by)
fn lt<I>(self, other: I) -> bool
Determines if the elements of this
Iterator are lexicographically less than those of another. Read more
fn le<I>(self, other: I) -> bool
Determines if the elements of this
Iterator are lexicographically less or equal to those of another. Read more
fn gt<I>(self, other: I) -> bool
Determines if the elements of this
Iterator are lexicographically greater than those of another. Read more
fn ge<I>(self, other: I) -> bool
Determines if the elements of this
Iterator are lexicographically greater than or equal to those of another. Read more
fn is_sorted_by<F>(self, compare: F) -> bool
Checks if the elements of this iterator are sorted using the given comparator function. Read more
fn is_sorted_by_key<F, K>(self, f: F) -> bool
Checks if the elements of this iterator are sorted using the given key extraction function. Read more
Auto Trait Implementations
impl<'a, T> Freeze for PermitIterator<'a, T>
impl<'a, T> RefUnwindSafe for PermitIterator<'a, T>
impl<'a, T> Send for PermitIterator<'a, T>where T: Send,
impl<'a, T> Sync for PermitIterator<'a, T>where T: Send,
impl<'a, T> Unpin for PermitIterator<'a, T>
impl<'a, T> UnsafeUnpin for PermitIterator<'a, T>
impl<'a, T> UnwindSafe for PermitIterator<'a, T>
Blanket Implementations
impl<T> BorrowMut<T> for Twhere T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Instrument for T
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<I> IntoIterator for Iwhere I: Iterator,
impl<T> WithSubscriber for T
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ
MIT License
Copyright © Tokio Contributors
https://docs.rs/tokio/1.53.1/tokio/sync/mpsc/struct.PermitIterator.html