DecodeUtf16 in core::char - Rust
Description: An iterator that decodes UTF-16 encoded code points from an iterator of `u16`s.

# Struct core::char::DecodeUtf16

1.9.0 · source ·

    pub struct DecodeUtf16<I>where
        I: Iterator<Item = u16>,{ /* private fields */ }

Expand description

An iterator that decodes UTF-16 encoded code points from an iterator of `u16`s.

This `struct` is created by the `decode_utf16` method on `char`. See its documentation for more.

## Trait Implementations§

source§

### impl<I> Clone for DecodeUtf16<I>
where I: Iterator<Item = u16> + Clone,

source§

#### fn clone(&self) -> DecodeUtf16<I> ⓘ

Returns a copy of the value. Read more
1.0.0 · source§

#### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more
source§

### impl<I> Debug for DecodeUtf16<I>
where I: Iterator<Item = u16> + Debug,

source§

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

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

### impl<I: Iterator<Item = u16>> Iterator for DecodeUtf16<I>

§

#### type Item = Result<char, DecodeUtf16Error>

The type of the elements being iterated over.
source§

#### fn next(&mut self) -> Option<Result<char, DecodeUtf16Error>>

Advances the iterator and returns the next value. Read more
source§

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

Returns the bounds on the remaining length of the iterator. Read more
source§

#### 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` #98326)
Advances the iterator and returns an array containing the next `N` values. Read more
1.0.0 · source§

#### fn count(self) -> usize
where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more
1.0.0 · source§

#### fn last(self) -> Option<Self::Item>
where Self: Sized,

Consumes the iterator, returning the last element. Read more
source§

#### fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (`iter_advance_by` #77404)
Advances the iterator by `n` elements. Read more
1.0.0 · source§

#### fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the `n`th element of the iterator. Read more
1.28.0 · source§

#### 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
1.0.0 · source§

#### fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> ⓘ
where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0 · source§

#### fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> ⓘ
where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs. Read more
source§

#### fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G> ⓘ
where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (`iter_intersperse` #79524)
Creates a new iterator which places an item generated by `separator` between adjacent items of the original iterator. Read more
1.0.0 · source§

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

Takes a closure and creates an iterator which calls that closure on each element. Read more
1.21.0 · source§

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

Calls a closure on each element of an iterator. Read more
1.0.0 · source§

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

Creates an iterator which uses a closure to determine if an element should be yielded. Read more
1.0.0 · source§

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

Creates an iterator that both filters and maps. Read more
1.0.0 · source§

#### 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
1.0.0 · source§

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

Creates an iterator which can use the `peek` and `peek_mut` methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
1.0.0 · source§

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

Creates an iterator that `skip`s elements based on a predicate. Read more
1.0.0 · source§

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

Creates an iterator that yields elements based on a predicate. Read more
1.57.0 · source§

#### fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> ⓘ
where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps. Read more
1.0.0 · source§

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

Creates an iterator that skips the first `n` elements. Read more
1.0.0 · source§

#### 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
1.0.0 · 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<B>,

An iterator adapter which, like `fold`, holds internal state, but unlike `fold`, produces a new iterator. Read more
1.0.0 · source§

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

Creates an iterator that works like map, but flattens nested structure. Read more
source§

#### fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N> ⓘ
where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (`iter_map_windows` #87155)
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
1.0.0 · source§

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

Creates an iterator which ends after the first `None`. Read more
1.0.0 · source§

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

Does something with each element of an iterator, passing the value on. Read more
1.0.0 · source§

#### fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Borrows an iterator, rather than consuming it. Read more
1.0.0 · source§

#### fn collect<B: FromIterator<Self::Item>>(self) -> B
where Self: Sized,

Transforms an iterator into a collection. Read more
source§

#### fn collect_into<E: Extend<Self::Item>>(self, collection: &mut E) -> &mut E
where Self: Sized,

🔬This is a nightly-only experimental API. (`iter_collect_into` #94780)
Collects all the items from an iterator into a collection. Read more
1.0.0 · source§

#### fn partition<B, F>(self, f: F) -> (B, B)
where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more
source§

#### fn is_partitioned<P>(self, predicate: P) -> bool
where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (`iter_is_partitioned` #62544)
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
1.27.0 · source§

#### fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
1.27.0 · source§

#### fn try_for_each<F, R>(&mut self, f: F) -> R
where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

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
1.0.0 · source§

#### fn fold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result. Read more
1.51.0 · source§

#### fn reduce<F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
source§

#### fn try_reduce<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<R::Output>>>::TryType
where Self: Sized, F: FnMut(Self::Item, Self::Item) -> R, R: Try<Output = Self::Item>, R::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (`iterator_try_reduce` #87053)
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
1.0.0 · source§

#### fn all<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more
1.0.0 · source§

#### fn any<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more
1.0.0 · source§

#### fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more
1.30.0 · source§

#### fn find_map<B, F>(&mut self, f: F) -> Option<B>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result. Read more
source§

#### fn try_find<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
where Self: Sized, F: FnMut(&Self::Item) -> R, R: Try<Output = bool>, R::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (`try_find` #63178)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
1.0.0 · source§

#### fn position<P>(&mut self, predicate: P) -> Option<usize>
where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more
1.6.0 · source§

#### fn max_by_key<B: Ord, F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function. Read more
1.15.0 · source§

#### fn max_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function. Read more
1.6.0 · source§

#### fn min_by_key<B: Ord, F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function. Read more
1.15.0 · source§

#### fn min_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function. Read more
1.0.0 · source§

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

Converts an iterator of pairs into a pair of containers. Read more
1.36.0 · source§

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

Creates an iterator which copies all of its elements. Read more
1.0.0 · source§

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

Creates an iterator which `clone`s all of its elements. Read more
source§

#### fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N> ⓘ
where Self: Sized,

🔬This is a nightly-only experimental API. (`iter_array_chunks` #100450)
Returns an iterator over `N` elements of the iterator at a time. Read more
1.11.0 · source§

#### fn sum<S>(self) -> S
where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator. Read more
1.11.0 · source§

#### fn product<P>(self) -> P
where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements Read more
source§

#### fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, I::Item) -> Ordering,

🔬This is a nightly-only experimental API. (`iter_order_by` #64295)
Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more
1.5.0 · source§

#### fn partial_cmp<I>(self, other: I) -> Option<Ordering>
where I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

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
source§

#### fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, I::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (`iter_order_by` #64295)
Lexicographically compares the elements of this `Iterator` with those of another with respect to the specified comparison function. Read more
1.5.0 · source§

#### fn eq<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<I::Item>, Self: Sized,

Determines if the elements of this `Iterator` are equal to those of another. Read more
source§

#### fn eq_by<I, F>(self, other: I, eq: F) -> bool
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, I::Item) -> bool,

🔬This is a nightly-only experimental API. (`iter_order_by` #64295)
Determines if the elements of this `Iterator` are equal to those of another with respect to the specified equality function. Read more
1.5.0 · source§

#### fn ne<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<I::Item>, Self: Sized,

Determines if the elements of this `Iterator` are not equal to those of another. Read more
1.5.0 · source§

#### fn lt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

Determines if the elements of this `Iterator` are lexicographically less than those of another. Read more
1.5.0 · source§

#### fn le<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

Determines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more
1.5.0 · source§

#### fn gt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

Determines if the elements of this `Iterator` are lexicographically greater than those of another. Read more
1.5.0 · source§

#### fn ge<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<I::Item>, Self: Sized,

Determines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. Read more
source§

#### fn is_sorted_by<F>(self, compare: F) -> bool
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

🔬This is a nightly-only experimental API. (`is_sorted` #53485)
Checks if the elements of this iterator are sorted using the given comparator function. Read more
source§

#### fn is_sorted_by_key<F, K>(self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

🔬This is a nightly-only experimental API. (`is_sorted` #53485)
Checks if the elements of this iterator are sorted using the given key extraction function. Read more
1.75.0 · source§

### impl<I: Iterator<Item = u16> + FusedIterator> FusedIterator for DecodeUtf16<I>

## Auto Trait Implementations§

§

### impl<I> Freeze for DecodeUtf16<I>
where I: Freeze,

§

### impl<I> RefUnwindSafe for DecodeUtf16<I>
where I: RefUnwindSafe,

§

### impl<I> Send for DecodeUtf16<I>
where I: Send,

§

### impl<I> Sync for DecodeUtf16<I>
where I: Sync,

§

### impl<I> Unpin for DecodeUtf16<I>
where I: Unpin,

§

### impl<I> UnwindSafe for DecodeUtf16<I>
where I: UnwindSafe,

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

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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<I> IntoIterator for I
where I: Iterator,

§

#### type Item = <I as Iterator>::Item

The type of the elements being iterated over.
§

#### type IntoIter = I

Which kind of iterator are we turning this into?
const: unstable · source§

#### fn into_iter(self) -> I

Creates an iterator from a value. Read more
source§

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

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.