diff --git a/src/error.rs b/src/error.rs index d6c69ee2..bba0ca99 100644 --- a/src/error.rs +++ b/src/error.rs @@ -30,30 +30,30 @@ use crate::stream::Stream; #[allow(unused_imports)] // Here for intra-doc links use crate::Parser; -/// For use with [`Parser::parse_peek`] which allows the input stream to be threaded through a -/// parser. +/// For use with [`Parser::parse_next`] /// -/// - `Ok((I, O))` is the remaining [input][crate::stream] and the parsed value +/// - `Ok(O)` is the parsed value /// - [`Err(ErrMode)`][ErrMode] is the error along with how to respond to it /// -/// By default, the error type (`E`) is [`InputError`] +/// By default, the error type (`E`) is [`ContextError`]. /// /// When integrating into the result of the application, see /// - [`Parser::parse`] /// - [`ErrMode::into_inner`] -pub type IResult> = PResult<(I, O), E>; +pub type PResult = Result>; -/// For use with [`Parser::parse_next`] +/// For use with [`Parser::parse_peek`] which allows the input stream to be threaded through a +/// parser. /// -/// - `Ok(O)` is the parsed value +/// - `Ok((I, O))` is the remaining [input][crate::stream] and the parsed value /// - [`Err(ErrMode)`][ErrMode] is the error along with how to respond to it /// -/// By default, the error type (`E`) is [`ContextError`]. +/// By default, the error type (`E`) is [`InputError`] /// /// When integrating into the result of the application, see /// - [`Parser::parse`] /// - [`ErrMode::into_inner`] -pub type PResult = Result>; +pub type IResult> = PResult<(I, O), E>; /// Contains information on needed data if a parser returned `Incomplete` ///