docs: Reduce reliance on peeking

src/_topic/language.rs

@@ -65,11 +65,11 @@
 //! token::take_till1,
 //! };
 //!
-//! pub fn peol_comment<'a, E: ParseError<&'a str>>(i: &'a str) -> IResult<&'a str, (), E>
+//! pub fn peol_comment<'a, E: ParseError<&'a str>>(i: &mut &'a str) -> PResult<(), E>
 //! {
 //! ('%', take_till1(['\n', '\r']))
 //! .void() // Output is thrown away.
-//! .parse_peek(i)
+//! .parse_next(i)
 //! }
 //! ```
 //!
@@ -85,14 +85,14 @@
 //! token::{tag, take_until0},
 //! };
 //!
-//! pub fn pinline_comment<'a, E: ParseError<&'a str>>(i: &'a str) -> IResult<&'a str, (), E> {
+//! pub fn pinline_comment<'a, E: ParseError<&'a str>>(i: &mut &'a str) -> PResult<(), E> {
 //! (
 //! "(*",
 //! take_until0("*)"),
 //! "*)"
 //! )
 //! .void() // Output is thrown away.
-//! .parse_peek(i)
+//! .parse_next(i)
 //! }
 //! ```
 //!
@@ -111,13 +111,13 @@
 //! token::one_of,
 //! };
 //!
-//! pub fn identifier(input: &str) -> IResult<&str, &str> {
+//! pub fn identifier<'s>(input: &mut &'s str) -> PResult<&'s str> {
 //! (
 //! one_of(|c: char| c.is_alpha() || c == '_'),
 //! take_while(0.., |c: char| c.is_alphanum() || c == '_')
 //! )
 //! .recognize()
-//! .parse_peek(input)
+//! .parse_next(input)
 //! }
 //! ```
 //!
@@ -162,13 +162,13 @@
 //! token::tag,
 //! };
 //!
-//! fn hexadecimal(input: &str) -> IResult<&str, &str> { // <'a, E: ParseError<&'a str>>
+//! fn hexadecimal<'s>(input: &mut &'s str) -> PResult<&'s str> { // <'a, E: ParseError<&'a str>>
 //! preceded(
 //! alt(("0x", "0X")),
 //! repeat(1..,
 //! terminated(one_of(('0'..='9', 'a'..='f', 'A'..='F')), repeat(0.., '_').map(|()| ()))
 //! ).map(|()| ()).recognize()
-//! ).parse_peek(input)
+//! ).parse_next(input)
 //! }
 //! ```
 //!
@@ -184,15 +184,15 @@
 //! token::tag,
 //! };
 //!
-//! fn hexadecimal_value(input: &str) -> IResult<&str, i64> {
+//! fn hexadecimal_value(input: &mut &str) -> PResult<i64> {
 //! preceded(
 //! alt(("0x", "0X")),
 //! repeat(1..,
 //! terminated(one_of(('0'..='9', 'a'..='f', 'A'..='F')), repeat(0.., '_').map(|()| ()))
 //! ).map(|()| ()).recognize()
 //! ).try_map(
 //! |out: &str| i64::from_str_radix(&str::replace(&out, "_", ""), 16)
-//! ).parse_peek(input)
+//! ).parse_next(input)
 //! }
 //! ```
 //!
@@ -210,13 +210,13 @@
 //! token::tag,
 //! };
 //!
-//! fn octal(input: &str) -> IResult<&str, &str> {
+//! fn octal<'s>(input: &mut &'s str) -> PResult<&'s str> {
 //! preceded(
 //! alt(("0o", "0O")),
 //! repeat(1..,
 //! terminated(one_of('0'..='7'), repeat(0.., '_').map(|()| ()))
 //! ).map(|()| ()).recognize()
-//! ).parse_peek(input)
+//! ).parse_next(input)
 //! }
 //! ```
 //!
@@ -232,13 +232,13 @@
 //! token::tag,
 //! };
 //!
-//! fn binary(input: &str) -> IResult<&str, &str> {
+//! fn binary<'s>(input: &mut &'s str) -> PResult<&'s str> {
 //! preceded(
 //! alt(("0b", "0B")),
 //! repeat(1..,
 //! terminated(one_of('0'..='1'), repeat(0.., '_').map(|()| ()))
 //! ).map(|()| ()).recognize()
-//! ).parse_peek(input)
+//! ).parse_next(input)
 //! }
 //! ```
 //!
@@ -253,12 +253,12 @@
 //! token::one_of,
 //! };
 //!
-//! fn decimal(input: &str) -> IResult<&str, &str> {
+//! fn decimal<'s>(input: &mut &'s str) -> PResult<&'s str> {
 //! repeat(1..,
 //! terminated(one_of('0'..='9'), repeat(0.., '_').map(|()| ()))
 //! ).map(|()| ())
 //! .recognize()
-//! .parse_peek(input)
+//! .parse_next(input)
 //! }
 //! ```
 //!

src/_topic/stream.rs

@@ -20,8 +20,8 @@
 //! # use winnow::token::tag;
 //! # type MyStream<'i> = &'i str;
 //! # type Output<'i> = &'i str;
-//! fn parser(i: MyStream<'_>) -> IResult<MyStream<'_>, Output<'_>> {
-//! "test".parse_peek(i)
+//! fn parser<'s>(i: &mut MyStream<'s>) -> PResult<Output<'s>> {
+//! "test".parse_next(i)
 //! }
 //! ```
 //!

src/trace/mod.rs

@@ -32,17 +32,17 @@ compile_error!("`debug` requires `std`");
 /// # use winnow::prelude::*;
 /// use winnow::trace::trace;
 ///
-/// fn short_alpha(s: &[u8]) -> IResult<&[u8], &[u8]> {
+/// fn short_alpha<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], Error<&'s [u8]>> {
 /// trace("short_alpha",
 /// take_while(3..=6, AsChar::is_alpha)
-/// ).parse_peek(s)
+/// ).parse_next(s)
 /// }
 ///
-/// assert_eq!(short_alpha(b"latin123"), Ok((&b"123"[..], &b"latin"[..])));
-/// assert_eq!(short_alpha(b"lengthy"), Ok((&b"y"[..], &b"length"[..])));
-/// assert_eq!(short_alpha(b"latin"), Ok((&b""[..], &b"latin"[..])));
-/// assert_eq!(short_alpha(b"ed"), Err(ErrMode::Backtrack(Error::new(&b"ed"[..], ErrorKind::Slice))));
-/// assert_eq!(short_alpha(b"12345"), Err(ErrMode::Backtrack(Error::new(&b"12345"[..], ErrorKind::Slice))));
+/// assert_eq!(short_alpha.parse_peek(b"latin123"), Ok((&b"123"[..], &b"latin"[..])));
+/// assert_eq!(short_alpha.parse_peek(b"lengthy"), Ok((&b"y"[..], &b"length"[..])));
+/// assert_eq!(short_alpha.parse_peek(b"latin"), Ok((&b""[..], &b"latin"[..])));
+/// assert_eq!(short_alpha.parse_peek(b"ed"), Err(ErrMode::Backtrack(Error::new(&b"ed"[..], ErrorKind::Slice))));
+/// assert_eq!(short_alpha.parse_peek(b"12345"), Err(ErrMode::Backtrack(Error::new(&b"12345"[..], ErrorKind::Slice))));
 /// ```
 #[cfg_attr(not(feature = "debug"), allow(unused_variables))]
 #[cfg_attr(not(feature = "debug"), allow(unused_mut))]