diff options
Diffstat (limited to 'vendor/winnow/src/_topic/stream.rs')
| -rw-r--r-- | vendor/winnow/src/_topic/stream.rs | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/vendor/winnow/src/_topic/stream.rs b/vendor/winnow/src/_topic/stream.rs new file mode 100644 index 0000000..2a9a79b --- /dev/null +++ b/vendor/winnow/src/_topic/stream.rs @@ -0,0 +1,66 @@ +//! # Custom [`Stream`] +//! +//! `winnow` is batteries included with support for +//! - Basic inputs like `&str`, newtypes with +//! - Improved debug output like [`Bytes`] +//! - [`Stateful`] for passing state through your parser, like tracking recursion +//! depth +//! - [`Located`] for looking up the absolute position of a token +//! +//! But that won't always cut it for your parser. For example, you might lex `&str` into +//! a series of tokens and then want to parse a `TokenStream`. +//! +//! ## Implementing a custom stream +//! +//! Let's assume we have an input type we'll call `MyStream`. +//! `MyStream` is a sequence of `MyItem` type. +//! +//! The goal is to define parsers with this signature: `&mut MyStream -> PResult<Output>`. +//! ```rust +//! # use winnow::prelude::*; +//! # use winnow::token::tag; +//! # type MyStream<'i> = &'i str; +//! # type Output<'i> = &'i str; +//! fn parser<'s>(i: &mut MyStream<'s>) -> PResult<Output<'s>> { +//! "test".parse_next(i) +//! } +//! ``` +//! +//! Here are the traits you may have to implement for `MyStream`: +//! +//! | trait | usage | +//! |---|---| +//! | [`Stream`] |Core trait for driving parsing| +//! | [`StreamIsPartial`] | Marks the input as being the complete buffer or a partial buffer for streaming input | +//! | [`AsBytes`] |Casts the input type to a byte slice| +//! | [`AsBStr`] |Casts the input type to a slice of ASCII / UTF-8-like bytes| +//! | [`Compare`] |Character comparison operations| +//! | [`FindSlice`] |Look for a substring in self| +//! | [`Location`] |Calculate location within initial input| +//! | [`Offset`] |Calculate the offset between slices| +//! +//! And for `MyItem`: +//! +//! | trait | usage | +//! |---|---| +//! | [`AsChar`] |Transforms common types to a char for basic token parsing| +//! | [`ContainsToken`] |Look for the token in the given set| +//! +//! And traits for `&[MyItem]`: +//! +//! | trait | usage | +//! |---|---| +//! | [`SliceLen`] |Calculate the input length| +//! | [`ParseSlice`] |Used to integrate `&str`'s `parse()` method| +//! +//! ## Implementing a custom token +//! +//! If you are parsing `&[Myitem]`, leaving just the `MyItem` traits. +//! +//! For example: +//! ```rust +#![doc = include_str!("../../examples/arithmetic/parser_lexer.rs")] +//! ``` + +#[allow(unused_imports)] // Here for intra-dock links +use crate::stream::*; |