Struct quoted_string::ContentChars

pub struct ContentChars<'a, Impl: GeneralQSSpec> { /* fields omitted */ }

A iterator over chars of the content represented by the quoted strings (PartialEq<&str>)

It will on the fly (without extra allocation) remove the surrounding quotes and unquote quoted-pairs

It implements Eq, and PartialEq with str, &str and itself. This enables to compare a quoted string with a string representing the content of a quoted string.

While it does not explicity checks for validity of the quoted-string it iterates over it still might notice that it is invalid as such it returns results (i.e. let the consumer decide how to handle the error). If you are fine with a panic if the ContentChars iterator was created from a invalid quoted-string, then just use .map(|r| r.expect("[BUG] ContentChars was created from malformed quoted-string"). (Note that the the only 2two thinks the current implementation does not check are if a char in a quoted-pair is valid (= is quotable) and it does not call end_validation on the internally used QuotedValidator, but thats a implementation detail for now)

Example

// use your own Spec instead
use quoted_string::test_utils::TestSpec;
use quoted_string::ContentChars;
use quoted_string::AsciiCaseInsensitiveEq;

let quoted_string = r#""ab\"\ c""#;
let cc = ContentChars::<TestSpec>::from_str(quoted_string);
assert_eq!(cc, "ab\" c");
assert!(cc.eq_ignore_ascii_case("AB\" c"));
assert_eq!(cc.collect::<Result<Vec<_>,_>>().unwrap().as_slice(), &[ 'a', 'b', '"', ' ', 'c' ] );

Methods

impl<'s, Impl> ContentChars<'s, Impl> where     Impl: GeneralQSSpec,

pub fn from_str(quoted: &'s str) -> Self

creates a char iterator over the content of a quoted string

the quoted string is assumed to be valid and not explicitely checked for validity but because of the way unquoting works a number of error can be detected

pub fn from_parts_unchecked(     partial_quoted_content: &'s str,     automaton: ScanAutomaton<Impl::Parsing> ) -> Self

creates a ContentChars iterator from a str and a QuotedValidator

The partial_quoted_content is assumed to be a valid quoted string without the surrounding '"'. It might not be a the complete content of a quoted string but if it isn't the q_validator is expected to have been used on a chars stripped on the left side (and no more than that). Note that it can work with using it on less then all chars but this depends on the Spec used. E.g. if any decison of the spec only depends on the current char (QuotedValidator is zero-sized) then no char had to be used with it.

Trait Implementations

impl<'a, Impl: Debug + GeneralQSSpec> Debug for ContentChars<'a, Impl> where     Impl::Parsing: Debug,

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

Formats the value using the given formatter.

impl<'a, Impl: Clone + GeneralQSSpec> Clone for ContentChars<'a, Impl> where     Impl::Parsing: Clone,

Important traits for ContentChars<'a, Impl>

impl<'a, Impl> Iterator for ContentChars<'a, Impl> where
    Impl: GeneralQSSpec,  type Item = Result<char, CoreError>;

fn clone(&self) -> ContentChars<'a, Impl>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Impl> Iterator for ContentChars<'a, Impl> where     Impl: GeneralQSSpec,

type Item = Result<char, CoreError>

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

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

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

Consumes the iterator, returning the last element.

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

Returns the nth element of the iterator.

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

🔬 This is a nightly-only experimental API. (iterator_step_by)

unstable replacement of Range::step_by

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

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

Takes two iterators and creates a new iterator over both in sequence.

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

'Zips up' two iterators into a single iterator of pairs.

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

Takes a closure and creates an iterator which calls that closure on each element.

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

Calls a closure on each element of an iterator.

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

Creates an iterator which uses a closure to determine if an element should be yielded.

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

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

Creates an iterator which can use peek to look at the next element of the iterator without consuming it.

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

Creates an iterator that [skip]s elements based on a predicate.

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

Creates an iterator that yields elements based on a predicate.

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

Creates an iterator that skips the first n elements.

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

Creates an iterator that yields its first n elements.

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

An iterator adaptor similar to [fold] that holds internal state and produces a new iterator.

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

Creates an iterator that works like map, but flattens nested structure.

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

🔬 This is a nightly-only experimental API. (iterator_flatten)

Creates an iterator that flattens nested structure.

fn fuse(self) -> Fuse<Self>

Creates an iterator which ends after the first [None].

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

Do something with each element of an iterator, passing the value on.

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

Borrows an iterator, rather than consuming it.

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

Transforms an iterator into a collection.

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

Consumes an iterator, creating two collections from it.

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

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

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

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

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

An iterator method that applies a function, producing a single, final value.

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

Tests if every element of the iterator matches a predicate.

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

Tests if any element of the iterator matches a predicate.

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

Searches for an element of an iterator that satisfies a predicate.

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

🔬 This is a nightly-only experimental API. (iterator_find_map)

unstable new API

Applies function to the elements of iterator and returns the first non-none result.

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

Searches for an element in an iterator, returning its index.

fn rposition<P>(&mut self, predicate: P) -> Option<usize> where     P: FnMut(Self::Item) -> bool,     Self: ExactSizeIterator + DoubleEndedIterator,

Searches for an element in an iterator from the right, returning its index.

fn max(self) -> Option<Self::Item> where     Self::Item: Ord,

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item> where     Self::Item: Ord,

Returns the minimum element of an iterator.

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

Returns the element that gives the maximum value from the specified function.

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

Returns the element that gives the maximum value with respect to the specified comparison function.

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

Returns the element that gives the minimum value from the specified function.

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

Returns the element that gives the minimum value with respect to the specified comparison function.

fn rev(self) -> Rev<Self> where     Self: DoubleEndedIterator,

Reverses an iterator's direction.

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

Converts an iterator of pairs into a pair of containers.

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

Creates an iterator which [clone]s all of its elements.

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

Repeats an iterator endlessly.

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

Sums the elements of an iterator.

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

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering where     I: IntoIterator<Item = Self::Item>,     Self::Item: Ord,

Lexicographically compares the elements of this Iterator with those of another.

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

Lexicographically compares the elements of this Iterator with those of another.

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

Determines if the elements of this Iterator are equal to those of another.

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

Determines if the elements of this Iterator are unequal to those of another.

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

Determines if the elements of this Iterator are lexicographically less than those of another.

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

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

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

Determines if the elements of this Iterator are lexicographically greater than those of another.

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

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

impl<'a, Spec> PartialEq<str> for ContentChars<'a, Spec> where     Spec: GeneralQSSpec,

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b, Spec> PartialEq<ContentChars<'b, Spec>> for &'a str where     Spec: GeneralQSSpec,

fn eq(&self, other: &ContentChars<'b, Spec>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b, Spec> PartialEq<&'b str> for ContentChars<'a, Spec> where     Spec: GeneralQSSpec,

fn eq(&self, other: &&'b str) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'b, Spec> PartialEq<ContentChars<'b, Spec>> for ContentChars<'a, Spec> where     Spec: GeneralQSSpec,

fn eq(&self, other: &ContentChars<'b, Spec>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, Spec> AsciiCaseInsensitiveEq<str> for ContentChars<'a, Spec> where     Spec: GeneralQSSpec,

fn eq_ignore_ascii_case(&self, other: &str) -> bool

compares this instance with other with a ascii case insensitive comparsion algorithm

impl<'a, 'b, Spec> AsciiCaseInsensitiveEq<ContentChars<'b, Spec>> for ContentChars<'a, Spec> where     Spec: GeneralQSSpec,

fn eq_ignore_ascii_case(&self, other: &ContentChars<'b, Spec>) -> bool

compares this instance with other with a ascii case insensitive comparsion algorithm

impl<'a, 'b, Spec> AsciiCaseInsensitiveEq<ContentChars<'b, Spec>> for &'a str where     Spec: GeneralQSSpec,

fn eq_ignore_ascii_case(&self, other: &ContentChars<'b, Spec>) -> bool

compares this instance with other with a ascii case insensitive comparsion algorithm

impl<'a, 'b, Spec> AsciiCaseInsensitiveEq<&'b str> for ContentChars<'a, Spec> where     Spec: GeneralQSSpec,

fn eq_ignore_ascii_case(&self, other: &&'b str) -> bool

compares this instance with other with a ascii case insensitive comparsion algorithm