Merge pull request #722 from epage/unit

fix(error): Deprcate ErrorKind
winnow-rs · Jan 29, 2025 · 8718a90 · 8718a90
2 parents 6385ba4 + 21a314f
commit 8718a90
Show file tree

Hide file tree

Showing 31 changed files with 608 additions and 513 deletions.
diff --git a/benches/number.rs b/benches/number.rs
@@ -5,7 +5,6 @@ use criterion::Criterion;
 
 use winnow::ascii::float;
 use winnow::binary::be_u64;
-use winnow::error::ErrorKind;
 use winnow::error::InputError;
 use winnow::error::ParserError;
 use winnow::prelude::*;
@@ -51,7 +50,7 @@ fn float_str(c: &mut Criterion) {
 fn std_float(input: &mut &[u8]) -> ModalResult<f64> {
     match input.parse_slice() {
         Some(n) => Ok(n),
-        None => Err(ParserError::from_error_kind(input, ErrorKind::Slice)),
+        None => Err(ParserError::from_input(input)),
     }
 }
 

diff --git a/examples/custom_error.rs b/examples/custom_error.rs
@@ -1,5 +1,6 @@
 use winnow::error::AddContext;
 use winnow::error::ErrMode;
+#[allow(deprecated)]
 use winnow::error::ErrorKind;
 use winnow::error::FromExternalError;
 use winnow::error::ParserError;
@@ -9,19 +10,19 @@ use winnow::stream::Stream;
 #[derive(Debug)]
 pub enum CustomError<I> {
     MyError,
-    Winnow(I, ErrorKind),
+    Winnow(I),
     External {
         cause: Box<dyn std::error::Error + Send + Sync + 'static>,
         input: I,
-        kind: ErrorKind,
     },
 }
 
 impl<I: Stream + Clone> ParserError<I> for CustomError<I> {
     type Inner = Self;
 
-    fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
-        CustomError::Winnow(input.clone(), kind)
+    #[allow(deprecated)]
+    fn from_error_kind(input: &I, _: ErrorKind) -> Self {
+        CustomError::Winnow(input.clone())
     }
 
     fn into_inner(self) -> Result<Self::Inner, Self> {
@@ -45,11 +46,11 @@ impl<I: Stream + Clone, E: std::error::Error + Send + Sync + 'static> FromExtern
     for CustomError<I>
 {
     #[inline]
-    fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self {
+    #[allow(deprecated)]
+    fn from_external_error(input: &I, _: ErrorKind, e: E) -> Self {
         CustomError::External {
             cause: Box::new(e),
             input: input.clone(),
-            kind,
         }
     }
 }

diff --git a/examples/json/bench.rs b/examples/json/bench.rs
@@ -31,15 +31,19 @@ fn json_bench(c: &mut criterion::Criterion) {
                 b.iter(|| parser_dispatch::json::<Error>.parse_peek(sample).unwrap());
             },
         );
-        group.bench_with_input(criterion::BenchmarkId::new("unit", name), &len, |b, _| {
-            type Error<'i> = ();
+        group.bench_with_input(
+            criterion::BenchmarkId::new("empty-error", name),
+            &len,
+            |b, _| {
+                type Error<'i> = winnow::error::EmptyError;
 
-            b.iter(|| {
-                parser_dispatch::json::<Error<'_>>
-                    .parse_peek(sample)
-                    .unwrap()
-            });
-        });
+                b.iter(|| {
+                    parser_dispatch::json::<Error<'_>>
+                        .parse_peek(sample)
+                        .unwrap()
+                });
+            },
+        );
         group.bench_with_input(criterion::BenchmarkId::new("alt", name), &len, |b, _| {
             type Error = winnow::error::ContextError;
 

diff --git a/examples/json/main.rs b/examples/json/main.rs
@@ -4,7 +4,7 @@ mod parser_dispatch;
 #[allow(dead_code)]
 mod parser_partial;
 
-use winnow::error::ErrorKind;
+use winnow::error::EmptyError;
 use winnow::prelude::*;
 
 fn main() -> Result<(), lexopt::Error> {
@@ -25,8 +25,8 @@ fn main() -> Result<(), lexopt::Error> {
     });
 
     let result = match args.implementation {
-        Impl::Naive => parser_alt::json::<ErrorKind>.parse(data),
-        Impl::Dispatch => parser_dispatch::json::<ErrorKind>.parse(data),
+        Impl::Naive => parser_alt::json::<EmptyError>.parse(data),
+        Impl::Dispatch => parser_dispatch::json::<EmptyError>.parse(data),
     };
     match result {
         Ok(json) => {

diff --git a/fuzz/fuzz_targets/fuzz_arithmetic.rs b/fuzz/fuzz_targets/fuzz_arithmetic.rs
@@ -28,10 +28,7 @@ fn incr(i: &mut &str) -> ModalResult<()> {
 
         // limit the number of recursions, the fuzzer keeps running into them
         if *l.borrow() >= 8192 {
-            Err(winnow::error::ParserError::from_error_kind(
-                i,
-                winnow::error::ErrorKind::Repeat,
-            ))
+            Err(winnow::error::ParserError::from_input(i))
         } else {
             Ok(())
         }

diff --git a/src/_tutorial/chapter_2.rs b/src/_tutorial/chapter_2.rs
@@ -11,14 +11,13 @@
 //! # use winnow::Result;
 //! use winnow::stream::Stream;
 //! use winnow::error::ParserError;
-//! use winnow::error::ErrorKind;
 //!
 //! fn parse_prefix(input: &mut &str) -> Result<char> {
 //!     let c = input.next_token().ok_or_else(|| {
-//!         ParserError::from_error_kind(input, ErrorKind::Token)
+//!         ParserError::from_input(input)
 //!     })?;
 //!     if c != '0' {
-//!         return Err(ParserError::from_error_kind(input, ErrorKind::Verify));
+//!         return Err(ParserError::from_input(input));
 //!     }
 //!     Ok(c)
 //! }
@@ -39,15 +38,14 @@
 //! ```rust
 //! # use winnow::Result;
 //! # use winnow::error::ParserError;
-//! # use winnow::error::ErrorKind;
 //! use winnow::Parser;
 //! use winnow::token::any;
 //!
 //! fn parse_prefix(input: &mut &str) -> Result<char> {
 //!     let c = any
 //!         .parse_next(input)?;
 //!     if c != '0' {
-//!         return Err(ParserError::from_error_kind(input, ErrorKind::Verify));
+//!         return Err(ParserError::from_input(input));
 //!     }
 //!     Ok(c)
 //! }
@@ -121,16 +119,15 @@
 //! # use winnow::Result;
 //! use winnow::stream::Stream;
 //! use winnow::error::ParserError;
-//! use winnow::error::ErrorKind;
 //!
 //! fn parse_prefix<'s>(input: &mut &'s str) -> Result<&'s str> {
 //!     let expected = "0x";
 //!     if input.len() < expected.len() {
-//!         return Err(ParserError::from_error_kind(input, ErrorKind::Slice));
+//!         return Err(ParserError::from_input(input));
 //!     }
 //!     let actual = input.next_slice(expected.len());
 //!     if actual != expected {
-//!         return Err(ParserError::from_error_kind(input, ErrorKind::Verify));
+//!         return Err(ParserError::from_input(input));
 //!     }
 //!     Ok(actual)
 //! }

diff --git a/src/_tutorial/chapter_7.rs b/src/_tutorial/chapter_7.rs
@@ -463,9 +463,9 @@
 //!
 //! To make [`ErrMode`] more convenient, Winnow provides [`ModalResult`]:
 //! ```rust
-//! # use winnow::error::ErrorKind;
+//! # use winnow::error::ContextError;
 //! # use winnow::error::ErrMode;
-//! pub type ModalResult<O, E = ErrorKind> = Result<O, ErrMode<E>>;
+//! pub type ModalResult<O, E = ContextError> = Result<O, ErrMode<E>>;
 //! ```
 //!
 //! So we can get the correct `context` by changing to [`ModalResult`] and adding [`cut_err`]:
@@ -722,7 +722,6 @@ use crate::combinator::fail;
 use crate::error::ContextError;
 use crate::error::ErrMode;
 use crate::error::ErrMode::*;
-use crate::error::ErrorKind;
 use crate::ModalResult;
 use crate::Parser;
 use crate::Result;