Type Alias winnow::stream::Str

pub type Str<'i> = &'i str;

UTF-8 Stream

Trait Implementations

impl<'a> AsBStr for &'a str

fn as_bstr(&self) -> &[u8]

Casts the input type to a byte slice

impl<'a, 'b> Compare<&'b [u8]> for &'a str

fn compare(&self, t: &'b [u8]) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, t: &'b [u8]) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'a, 'b> Compare<&'b str> for &'a str

fn compare(&self, t: &'b str) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, t: &'b str) -> CompareResult

Compares self to another value for equality independently of the case.

impl Default for &str

fn default() -> &str

Creates an empty str

impl !Error for &str

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl<'i, 's> FindSlice<&'s str> for &'i str

fn find_slice(&self, substr: &'s str) -> Option<usize>

Returns the offset of the slice if it is found

impl<'i> FindSlice<char> for &'i str

fn find_slice(&self, substr: char) -> Option<usize>

Returns the offset of the slice if it is found

impl<'a> Offset<&'a str> for &'a str

fn offset_from(&self, start: &Self) -> usize

Offset between the first byte of start and the first byte of self

impl<'a> Offset<<&'a str as Stream>::Checkpoint> for &'a str

fn offset_from(&self, other: &<&'a str as Stream>::Checkpoint) -> usize

Offset between the first byte of start and the first byte of self

impl<'a, R: FromStr> ParseSlice<R> for &'a str

fn parse_slice(&self) -> Option<R>

Succeeds if parse() succeededThe

impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s strwhere I: Compare<&'s str> + StreamIsPartial + Stream,

This is a shortcut for tag.

Example

fn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
  alt(("Hello", take(5usize))).parse_next(s)
}

assert_eq!(parser.parse_peek("Hello, World!"), Ok((", World!", "Hello")));
assert_eq!(parser.parse_peek("Something"), Ok(("hing", "Somet")));
assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Slice))));
assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));

fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E>

Take tokens from the Stream, turning it into the output

fn parse_peek(&mut self, input: I) -> IResult<I, O, E>

Take tokens from the Stream, turning it into the output

fn by_ref(&mut self) -> ByRef<'_, Self>where Self: Sized,

Treat &mut Self as a parser

fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>where Self: Sized, O2: Clone,

Produce the provided value

fn void(self) -> Void<Self, I, O, E>where Self: Sized,

Discards the output of the Parser

fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>where Self: Sized, O: Into<O2>,

Convert the parser’s output to another type using std::convert::From

fn recognize(self) -> Recognize<Self, I, O, E>where Self: Sized, I: Stream,

Produce the consumed input as produced value.

fn with_recognized(self) -> WithRecognized<Self, I, O, E>where Self: Sized, I: Stream,

Produce the consumed input with the output

fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>where G: Fn(O) -> O2, Self: Sized,

Maps a function over the output of a parser

fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>where Self: Sized, G: FnMut(O) -> Result<O2, E2>, I: Stream, E: FromExternalError<I, E2>,

Applies a function returning a Result over the output of a parser.

fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>where Self: Sized, G: FnMut(O) -> Option<O2>, I: Stream, E: ParserError<I>,

Apply both Parser::verify and Parser::map.

fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>where Self: Sized, G: FnMut(O) -> H, H: Parser<I, O2, E>,

Creates a parser from the output of this one

fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>where Self: Sized, I: Stream, O: ParseSlice<O2>, E: ParserError<I>,

Apply std::str::FromStr to the output of the parser

fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>where Self: Sized, G: Fn(&O2) -> bool, I: Stream, O: Borrow<O2>, O2: ?Sized, E: ParserError<I>,

Returns the output of the child parser if it satisfies a verification function.

fn context<C>(self, context: C) -> Context<Self, I, O, E, C>where Self: Sized, I: Stream, E: AddContext<I, C>, C: Clone + Debug,

If parsing fails, add context to the error

fn complete_err(self) -> CompleteErr<Self>where Self: Sized,

Transforms Incomplete into Backtrack

fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>where Self: Sized, E: Into<E2>,

Convert the parser’s error to another type using std::convert::From

impl<'a, 'b> PartialEq<BStr> for &'a str

fn eq(&self, other: &BStr) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialEq<Bytes> for &'a str

fn eq(&self, other: &Bytes) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialEq<Cow<'a, str>> for &'b str

fn eq(&self, other: &Cow<'a, str>) -> bool

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

fn ne(&self, other: &Cow<'a, str>) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialEq<OsString> for &'a str

fn eq(&self, other: &OsString) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialEq<String> for &'a str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialOrd<BStr> for &'a str

fn partial_cmp(&self, other: &BStr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, 'b> PartialOrd<Bytes> for &'a str

fn partial_cmp(&self, other: &Bytes) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, 'b> Pattern<'a> for &'b str

Non-allocating substring search.

Will handle the pattern "" as returning empty matches at each character boundary.

Examples

assert_eq!("Hello world".find("world"), Some(6));

fn is_prefix_of(self, haystack: &'a str) -> bool

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

Checks whether the pattern matches at the front of the haystack.

fn is_contained_in(self, haystack: &'a str) -> bool

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

Checks whether the pattern matches anywhere in the haystack

fn strip_prefix_of(self, haystack: &'a str) -> Option<&'a str>

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

Removes the pattern from the front of haystack, if it matches.

fn is_suffix_of(self, haystack: &'a str) -> bool

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

Checks whether the pattern matches at the back of the haystack.

fn strip_suffix_of(self, haystack: &'a str) -> Option<&'a str>

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

Removes the pattern from the back of haystack, if it matches.

type Searcher = StrSearcher<'a, 'b>

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

Associated searcher for this pattern

fn into_searcher(self, haystack: &'a str) -> StrSearcher<'a, 'b>

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

Constructs the associated searcher from self and the haystack to search in.

impl<'a> SliceLen for &'a str

fn slice_len(&self) -> usize

Calculates the input length, as indicated by its name, and the name of the trait itself

impl<'i> Stream for &'i str

type Token = char

The smallest unit being parsed

type Slice = &'i str

Sequence of Tokens

type IterOffsets = CharIndices<'i>

Iterate with the offset from the current location

type Checkpoint = Checkpoint<&'i str>

A parse location within the stream

fn iter_offsets(&self) -> Self::IterOffsets

Iterate with the offset from the current location

fn eof_offset(&self) -> usize

Returns the offaet to the end of the input

fn next_token(&mut self) -> Option<Self::Token>

Split off the next token from the input

fn offset_for<P>(&self, predicate: P) -> Option<usize>where P: Fn(Self::Token) -> bool,

Finds the offset of the next matching token

fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

Get the offset for the number of tokens into the stream

fn next_slice(&mut self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input

fn checkpoint(&self) -> Self::Checkpoint

Save the current parse location within the stream

fn reset(&mut self, checkpoint: Self::Checkpoint)

Revert the stream to a prior Self::Checkpoint

fn raw(&self) -> &dyn Debug

Return the inner-most stream

fn peek_token(&self) -> Option<(Self, Self::Token)>where Self: Clone,

Split off the next token from the input

fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)where Self: Clone,

Split off a slice of tokens from the input

fn finish(&mut self) -> Self::Slice

Advance to the end of the stream

fn peek_finish(&self) -> (Self, Self::Slice)where Self: Clone,

Advance to the end of the stream

impl<'a> StreamIsPartial for &'a str

type PartialState = ()

Whether the stream is currently partial or complete

fn complete(&mut self) -> Self::PartialState

Mark the stream is complete

fn restore_partial(&mut self, _state: Self::PartialState)

Restore the stream back to its previous state

fn is_partial_supported() -> bool

Report whether the Stream is can ever be incomplete

fn is_partial(&self) -> bool

Report whether the Stream is currently incomplete

impl<'a> TryFrom<&'a OsStr> for &'a str

fn try_from( value: &'a OsStr ) -> Result<&'a str, <&'a str as TryFrom<&'a OsStr>>::Error>

Tries to convert an &OsStr to a &str.

use std::ffi::OsStr;

let os_str = OsStr::new("foo");
let as_str = <&str>::try_from(os_str).unwrap();
assert_eq!(as_str, "foo");

type Error = Utf8Error

The type returned in the event of a conversion error.

impl<'a> UpdateSlice for &'a str

fn update_slice(self, inner: Self::Slice) -> Self

Convert an Output type to be used as Stream