pub struct StringIter<'t> { /* private fields */ }
Expand description
A double ended, UTF-8 char
based Iterator
for &str
s that
supports iterating, looking ahead, trimming, pattern matching, splitting
and other common string operations.
Also a drop in replacement for an AsRef<str>
or a Borrow<str>
.
Implementations§
Source§impl<'t> StringIter<'t>
impl<'t> StringIter<'t>
Sourcepub fn try_next_slice<P: Pattern>(
&mut self,
pat: P,
) -> Result<Option<&'t str>, P::Err>
pub fn try_next_slice<P: Pattern>( &mut self, pat: P, ) -> Result<Option<&'t str>, P::Err>
Gets a slice out of a StringIter using a fallible pattern.
If Err is Never
, you can use
the infallible version instead.
The iterator will not be changed if the match fails.
§Pattern
§Pattern Configuration
see SetSep
Sourcepub fn try_next_slice_back<P: Pattern>(
&mut self,
pat: P,
) -> Result<Option<&'t str>, P::Err>
pub fn try_next_slice_back<P: Pattern>( &mut self, pat: P, ) -> Result<Option<&'t str>, P::Err>
Gets a slice from a StringIter in reverse, using a fallible pattern.
If Err is Never
, you can use
the infallible version instead.
The iterator will not be changed if the match fails.
See try_next_slice
Sourcepub fn next_slice<P: Pattern<Err = Never>>(&mut self, pat: P) -> Option<&'t str>
pub fn next_slice<P: Pattern<Err = Never>>(&mut self, pat: P) -> Option<&'t str>
Gets a slice from a StringIter, using a non-fallible pattern.
See try_next_slice
Sourcepub fn next_slice_back<P: Pattern<Err = Never>>(
&mut self,
pat: P,
) -> Option<&'t str>
pub fn next_slice_back<P: Pattern<Err = Never>>( &mut self, pat: P, ) -> Option<&'t str>
Gets a slice from a StringIter in reverse, using a non-fallible pattern.
See try_next_slice
Source§impl<'t> StringIter<'t>
impl<'t> StringIter<'t>
Sourcepub fn into_substrs(
self,
pat: impl Pattern<Err = Never>,
) -> SplitIter<'t, impl Pattern<Err = Never>> ⓘ
pub fn into_substrs( self, pat: impl Pattern<Err = Never>, ) -> SplitIter<'t, impl Pattern<Err = Never>> ⓘ
Split the string into substrings
by repeatedly calling next_slice()
with a pattern,
while ensuring at least one char
is consumed each call.
This iterator does not attempt to remove empty strings,
use filter()
for that.
§Explanation
If ran on the entire string, this can be viewed as:
Call pat.match()
on each char
Retain
: separate if the next char returnstrue
Yield
: separate if this char returnstrue
Split
: separate if this char returnstrue
, and remove this char.
§Panics
If pat.sep_method()
is Conjoin
§Implementation Detail
For Retain
patterns,
match()
is called on first char,
but its output is ignored.
Sourcepub fn into_splits(
self,
pat: impl Pattern<Err = Never>,
) -> SplitIter<'t, impl Pattern<Err = Never>> ⓘ
pub fn into_splits( self, pat: impl Pattern<Err = Never>, ) -> SplitIter<'t, impl Pattern<Err = Never>> ⓘ
Convenient method for into_substrs
using Sep::Split
.
Source§impl<'t> StringIter<'t>
impl<'t> StringIter<'t>
Sourcepub fn next_char_back(&mut self) -> Option<(char, &'t str)>
pub fn next_char_back(&mut self) -> Option<(char, &'t str)>
Sourcepub fn trim_by(&mut self, f: impl Pattern<Err = Never> + Clone)
pub fn trim_by(&mut self, f: impl Pattern<Err = Never> + Clone)
Removes leading and trailing char
s that matches a Pattern
from the StringIter
.
Sourcepub fn trim_start_by(&mut self, f: impl Pattern<Err = Never>)
pub fn trim_start_by(&mut self, f: impl Pattern<Err = Never>)
Removes leading char
s that matches a Pattern
from the StringIter
.
Sourcepub fn trim_end_by(&mut self, f: impl Pattern<Err = Never>)
pub fn trim_end_by(&mut self, f: impl Pattern<Err = Never>)
Removes trailing char
s that matches a Pattern
from the StringIter
.
Source§impl<'t> StringIter<'t>
impl<'t> StringIter<'t>
Sourcepub fn chars(self) -> CharIter<'t> ⓘ
pub fn chars(self) -> CharIter<'t> ⓘ
Map the iterator into an Iterator<Item = char>
.
Discarding the str output
Sourcepub fn strs(self) -> StrIter<'t> ⓘ
pub fn strs(self) -> StrIter<'t> ⓘ
Map the iterator into an Iterator<Item = &str>
.
Discarding the char output
Sourcepub fn ascii(self) -> AsciiIter<'t> ⓘ
pub fn ascii(self) -> AsciiIter<'t> ⓘ
Map the iterator into an Iterator<Item = u8>
.
where u8 is the first byte of the &str.
Sourcepub fn ascii_str(self) -> AsciiStrIter<'t> ⓘ
pub fn ascii_str(self) -> AsciiStrIter<'t> ⓘ
Map the iterator into an Iterator<Item = (u8, &str)>
.
where u8 is the first byte of the &str.
Sourcepub fn look_ahead(self, len: usize) -> LookAhead<'t> ⓘ
pub fn look_ahead(self, len: usize) -> LookAhead<'t> ⓘ
Make the iterator peek for len
.
Source§impl<'t> StringIter<'t>
impl<'t> StringIter<'t>
Sourcepub const fn is_empty(&self) -> bool
pub const fn is_empty(&self) -> bool
Returns true
if the underlying str
has a length of zero bytes.
Sourcepub const fn as_str(&self) -> &'t str
pub const fn as_str(&self) -> &'t str
Returns the underlying str
of this StringIter
Sourcepub const fn as_bytes(&self) -> &'t [u8]
pub const fn as_bytes(&self) -> &'t [u8]
Returns the underlying [u8]
of this StringIter
Sourcepub fn startswith(&self, s: &str) -> bool
pub fn startswith(&self, s: &str) -> bool
Sourcepub fn trim(&mut self)
pub fn trim(&mut self)
Removes leading and trailing whitespaces from this StringIter
Sourcepub fn trim_start(&mut self)
pub fn trim_start(&mut self)
Removes leading whitespaces from this StringIter
Sourcepub fn trim_end(&mut self)
pub fn trim_end(&mut self)
Removes trailing whitespaces from this StringIter
Sourcepub fn skip_front(&mut self, n: usize) -> bool
pub fn skip_front(&mut self, n: usize) -> bool
Skip n
leading char
s from this StringIter
,
returns true
if the string is empty afterwards.
Trait Implementations§
Source§impl AsRef<str> for StringIter<'_>
impl AsRef<str> for StringIter<'_>
Source§impl Borrow<str> for StringIter<'_>
impl Borrow<str> for StringIter<'_>
Source§impl<'t> Clone for StringIter<'t>
impl<'t> Clone for StringIter<'t>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<'t> Debug for StringIter<'t>
impl<'t> Debug for StringIter<'t>
Source§impl<'t> Display for StringIter<'t>
impl<'t> Display for StringIter<'t>
Source§impl<'t> DoubleEndedIterator for StringIter<'t>
impl<'t> DoubleEndedIterator for StringIter<'t>
Source§fn next_back(&mut self) -> Option<Self::Item>
fn next_back(&mut self) -> Option<Self::Item>
Source§fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
iter_advance_by
)n
elements. Read more1.37.0 · Source§fn nth_back(&mut self, n: usize) -> Option<Self::Item>
fn nth_back(&mut self, n: usize) -> Option<Self::Item>
n
th element from the end of the iterator. Read more1.27.0 · Source§fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R
fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R
Iterator::try_fold()
: it takes
elements starting from the back of the iterator. Read moreSource§impl<'t> From<&'t String> for StringIter<'t>
impl<'t> From<&'t String> for StringIter<'t>
Source§impl<'t> From<&'t str> for StringIter<'t>
impl<'t> From<&'t str> for StringIter<'t>
Source§impl<'t> Into<&'t str> for StringIter<'t>
impl<'t> Into<&'t str> for StringIter<'t>
Source§impl<'t> Into<String> for StringIter<'t>
impl<'t> Into<String> for StringIter<'t>
Source§impl<'t> Iterator for StringIter<'t>
impl<'t> Iterator for StringIter<'t>
Source§fn next(&mut self) -> Option<Self::Item>
fn next(&mut self) -> Option<Self::Item>
Source§fn size_hint(&self) -> (usize, Option<usize>)
fn size_hint(&self) -> (usize, Option<usize>)
Source§fn count(self) -> usize
fn count(self) -> usize
Source§fn next_chunk<const N: usize>(
&mut self,
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
fn next_chunk<const N: usize>(
&mut self,
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
iter_next_chunk
)N
values. Read more1.0.0 · Source§fn last(self) -> Option<Self::Item>where
Self: Sized,
fn last(self) -> Option<Self::Item>where
Self: Sized,
Source§fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
iter_advance_by
)n
elements. Read more1.0.0 · Source§fn nth(&mut self, n: usize) -> Option<Self::Item>
fn nth(&mut self, n: usize) -> Option<Self::Item>
n
th element of the iterator. Read more1.28.0 · Source§fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
1.0.0 · Source§fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
1.0.0 · Source§fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
Source§fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
iter_intersperse
)separator
between adjacent
items of the original iterator. Read moreSource§fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
iter_intersperse
)separator
between adjacent items of the original iterator. Read more1.0.0 · Source§fn map<B, F>(self, f: F) -> Map<Self, F>
fn map<B, F>(self, f: F) -> Map<Self, F>
1.0.0 · Source§fn filter<P>(self, predicate: P) -> Filter<Self, P>
fn filter<P>(self, predicate: P) -> Filter<Self, P>
1.0.0 · Source§fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
1.0.0 · Source§fn enumerate(self) -> Enumerate<Self>where
Self: Sized,
fn enumerate(self) -> Enumerate<Self>where
Self: Sized,
1.0.0 · Source§fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
1.0.0 · Source§fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
1.57.0 · Source§fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
1.0.0 · Source§fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
n
elements. Read more1.0.0 · Source§fn take(self, n: usize) -> Take<Self>where
Self: Sized,
fn take(self, n: usize) -> Take<Self>where
Self: Sized,
n
elements, or fewer
if the underlying iterator ends sooner. Read more1.0.0 · Source§fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
1.29.0 · Source§fn flatten(self) -> Flatten<Self>
fn flatten(self) -> Flatten<Self>
Source§fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
iter_map_windows
)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 more1.0.0 · Source§fn inspect<F>(self, f: F) -> Inspect<Self, F>
fn inspect<F>(self, f: F) -> Inspect<Self, F>
1.0.0 · Source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Iterator
. Read moreSource§fn try_collect<B>(
&mut self,
) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
iterator_try_collect
)Source§fn collect_into<E>(self, collection: &mut E) -> &mut E
fn collect_into<E>(self, collection: &mut E) -> &mut E
iter_collect_into
)1.0.0 · Source§fn partition<B, F>(self, f: F) -> (B, B)
fn partition<B, F>(self, f: F) -> (B, B)
Source§fn partition_in_place<'a, T, P>(self, predicate: P) -> usize
fn partition_in_place<'a, T, P>(self, predicate: P) -> usize
iter_partition_in_place
)true
precede all those that return false
.
Returns the number of true
elements found. Read moreSource§fn is_partitioned<P>(self, predicate: P) -> bool
fn is_partitioned<P>(self, predicate: P) -> bool
iter_is_partitioned
)true
precede all those that return false
. Read more1.27.0 · Source§fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
1.27.0 · Source§fn try_for_each<F, R>(&mut self, f: F) -> R
fn try_for_each<F, R>(&mut self, f: F) -> R
1.0.0 · Source§fn fold<B, F>(self, init: B, f: F) -> B
fn fold<B, F>(self, init: B, f: F) -> B
1.51.0 · Source§fn reduce<F>(self, f: F) -> Option<Self::Item>
fn reduce<F>(self, f: F) -> Option<Self::Item>
Source§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
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
iterator_try_reduce
)1.0.0 · Source§fn all<F>(&mut self, f: F) -> bool
fn all<F>(&mut self, f: F) -> bool
1.0.0 · Source§fn any<F>(&mut self, f: F) -> bool
fn any<F>(&mut self, f: F) -> bool
1.0.0 · Source§fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
1.30.0 · Source§fn find_map<B, F>(&mut self, f: F) -> Option<B>
fn find_map<B, F>(&mut self, f: F) -> Option<B>
Source§fn try_find<R>(
&mut self,
f: impl FnMut(&Self::Item) -> R,
) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
try_find
)1.0.0 · Source§fn position<P>(&mut self, predicate: P) -> Option<usize>
fn position<P>(&mut self, predicate: P) -> Option<usize>
1.0.0 · Source§fn max(self) -> Option<Self::Item>
fn max(self) -> Option<Self::Item>
1.0.0 · Source§fn min(self) -> Option<Self::Item>
fn min(self) -> Option<Self::Item>
1.6.0 · Source§fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
1.15.0 · Source§fn max_by<F>(self, compare: F) -> Option<Self::Item>
fn max_by<F>(self, compare: F) -> Option<Self::Item>
1.6.0 · Source§fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
1.15.0 · Source§fn min_by<F>(self, compare: F) -> Option<Self::Item>
fn min_by<F>(self, compare: F) -> Option<Self::Item>
1.0.0 · Source§fn rev(self) -> Rev<Self>where
Self: Sized + DoubleEndedIterator,
fn rev(self) -> Rev<Self>where
Self: Sized + DoubleEndedIterator,
1.0.0 · Source§fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
1.36.0 · Source§fn copied<'a, T>(self) -> Copied<Self>
fn copied<'a, T>(self) -> Copied<Self>
Source§fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,
fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,
iter_array_chunks
)N
elements of the iterator at a time. Read more1.11.0 · Source§fn product<P>(self) -> P
fn product<P>(self) -> P
Source§fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
iter_order_by
)Iterator
with those
of another with respect to the specified comparison function. Read more1.5.0 · Source§fn partial_cmp<I>(self, other: I) -> Option<Ordering>
fn partial_cmp<I>(self, other: I) -> Option<Ordering>
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 moreSource§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>,
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>,
iter_order_by
)Iterator
with those
of another with respect to the specified comparison function. Read moreSource§fn eq_by<I, F>(self, other: I, eq: F) -> bool
fn eq_by<I, F>(self, other: I, eq: F) -> bool
iter_order_by
)1.5.0 · Source§fn lt<I>(self, other: I) -> bool
fn lt<I>(self, other: I) -> bool
Iterator
are lexicographically
less than those of another. Read more1.5.0 · Source§fn le<I>(self, other: I) -> bool
fn le<I>(self, other: I) -> bool
Iterator
are lexicographically
less or equal to those of another. Read more1.5.0 · Source§fn gt<I>(self, other: I) -> bool
fn gt<I>(self, other: I) -> bool
Iterator
are lexicographically
greater than those of another. Read more1.5.0 · Source§fn ge<I>(self, other: I) -> bool
fn ge<I>(self, other: I) -> bool
Iterator
are lexicographically
greater than or equal to those of another. Read more1.82.0 · Source§fn is_sorted(self) -> bool
fn is_sorted(self) -> bool
1.82.0 · Source§fn is_sorted_by<F>(self, compare: F) -> bool
fn is_sorted_by<F>(self, compare: F) -> bool
1.82.0 · Source§fn is_sorted_by_key<F, K>(self, f: F) -> bool
fn is_sorted_by_key<F, K>(self, f: F) -> bool
Source§impl PartialEq<&str> for StringIter<'_>
impl PartialEq<&str> for StringIter<'_>
Source§impl PartialEq<str> for StringIter<'_>
impl PartialEq<str> for StringIter<'_>
Source§impl PartialOrd<&str> for StringIter<'_>
impl PartialOrd<&str> for StringIter<'_>
Source§impl PartialOrd<str> for StringIter<'_>
impl PartialOrd<str> for StringIter<'_>
Source§impl<'t> TryFrom<Cow<'t, str>> for StringIter<'t>
This conversion only works if the Cow
is Borrowed
impl<'t> TryFrom<Cow<'t, str>> for StringIter<'t>
This conversion only works if the Cow
is Borrowed
impl<'t> FusedIterator for StringIter<'t>
Auto Trait Implementations§
impl<'t> Freeze for StringIter<'t>
impl<'t> RefUnwindSafe for StringIter<'t>
impl<'t> Send for StringIter<'t>
impl<'t> Sync for StringIter<'t>
impl<'t> Unpin for StringIter<'t>
impl<'t> UnwindSafe for StringIter<'t>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<I> IntoIterator for Iwhere
I: Iterator,
impl<I> IntoIterator for Iwhere
I: Iterator,
Source§impl<T> StringExt for T
impl<T> StringExt for T
Source§fn try_substr<'t>(&'t self, idx: impl StringIndex) -> Result<&'t str, &'t str>
fn try_substr<'t>(&'t self, idx: impl StringIndex) -> Result<&'t str, &'t str>
Source§fn try_substr_back<'t>(
&'t self,
idx: impl StringIndex,
) -> Result<&'t str, &'t str>
fn try_substr_back<'t>( &'t self, idx: impl StringIndex, ) -> Result<&'t str, &'t str>
Source§fn merge<'t>(&'t self, first: &str, second: &str) -> Option<&'t str>
fn merge<'t>(&'t self, first: &str, second: &str) -> Option<&'t str>
Source§fn substr<'t>(&'t self, idx: impl StringIndex) -> &'t str
fn substr<'t>(&'t self, idx: impl StringIndex) -> &'t str
Source§fn substr_back<'t>(&'t self, idx: impl StringIndex) -> &'t str
fn substr_back<'t>(&'t self, idx: impl StringIndex) -> &'t str
Source§impl<T> StringIterable for T
impl<T> StringIterable for T
Source§fn str_iter<'t>(&'t self) -> StringIter<'t> ⓘ
fn str_iter<'t>(&'t self) -> StringIter<'t> ⓘ
StringIter