winnow

chore: Release winnow version 1.0.4

Fixes

• Expand the number of supported fields for seq! from 22 to 32

chore: Release winnow version 1.0.3

Fixes

• Remove unused AsBStr bound on ascii::float

chore: Release winnow version 1.0.2

Fixes

• Support TreeError in binary::bits (regression from 1.0.0)

chore: Release winnow version 1.0.1

Documentation

• Ensure macros are visible at winnow::combinator

chore: Release winnow version 1.0.0

Note: going to v1 is more a reflection of the rate of churn in Winnow's API than the quality of previous releases or any statement against future breaking changes.

Migration Guide

1. Update to latest v0.7 release
2. Resolve deprecations
3. Upgrade to v1
4. Add ascii, binary, or parser features as needed
5. Break tuples into tuples-of-tuples as needed
6. Break alt tuples into tuples of alt tuples as needed

Compatibility

• Added parser, ascii, and binary feature gates to improve build times
• Reduce 'impl ContainsToken for Tuple' to 10 elements to improve build times
• Reduce 'impl Alt for Tuple' to 10 elements to improve build times
• Reduce 'impl Parser for Tuple' to 10 elements to improve build times
• Replaced (I, usize) with binary::bits::Bits to clarify intent
• Moved BitOffsets from stream to binary::bits to consolidate the API
• Make iterator impure like parsers
• Replace Stream::raw with Stream::trace
• Remove deprecated APIs

Performance

Build time

• Reduce macro-generated code
• Split off parser, ascii, and binary features

Runtime

• Optimize hex_uint

Features

• Add Parser::parse_iter

Fixes

• Export Needed in stream
• Correct trace for oct_digit1
• Allow escaped into a Cow
• Accept a parser for escaped, take_escaped control character for not-quite unicode parsing

chore: Release winnow version 0.7.15

Compatibility

• Deprecate combinator::permutation in favor of combinator::unordered_seq!

Features

• Add combinator::unordered_seq!, like seq! but where the order of values does not matter

chore: Release winnow version 0.7.14

Features

• Add combinator::expression parser for parsing expressions with precedence (a pratt parser)

chore: Release winnow version 0.7.13

Features

• Allow accumulating String into String
• Allow accumulating Cow<str> into String

chore: Release winnow version 0.7.12

Features

• Add impl Accumulate for VecDeque

Fixes

• Remove a stackoverflow in PartialEq and PartialOrd with Bytes and BStr

Compatibility

• Deprecated Stream::raw

Features

• Added Stream::trace for better customization of trace parsers

Fixes

• Remove initial from TokenSlice / LocatingSlices Debug impl
• Stream::trace prints non-pretty output for &[T] and TokenSlice<T>

Features

• Add ContextError::extend
• Add Parser::context_with

Features

• Add ContextError::push
• Add Parser::map_err

Fixes

• Ensure LocatedSlice and Statefuls Stream::raw gets the inner input

Features

• Add TokenSlice::previous_tokens

Features

• Add Stream::next_slice_unchecked and Stream::peek_slice_unchecked

Documentation

• Clarify empty
• Clarify dispatch!
• (cookbook) Discuss lexing
• (tutorial) Iterate on how we discuss errors

Features

• Add ParseError::char_span

Fixes

• Make Range Copyable

Fixes

• Don't panic when calling .next(), .next(), .finish() on iterator

Migration Guide

1. Upgrade to the latest 0.6 release
2. Resolve all deprecations
3. Replace impl Parser<_, _, _> with impl ModalParser<_, _, _>
4. Upgrade to 0.7.0
5. Resolve any compiler errors

• For custom errors, remove switch from from_error_kind to from_input and remove other kind parameters
• For seq!(<tuple>), you may need to add mut to shared parsers
• For Stream::peek* calls, update for lack of Stream being returned
• Where ModalParser couldn't be used, change Parser<I, O, E> to Parser<I, O, ErrMode<E>>

1. Resolve all deprecations

If you do not use cut_err or Partial, you can further clean up the code and improve performance by removing the use of ErrMode

• Replace ModalResult<O, E> with winnow::Result<O> (if using default error type) or just Result<O, E>
• Replace impl ModalParser with impl Parser
• Remove uses of ErrMode

Compatibility

• escaped and take_escaped now assert, rather than stop, on empty normal output
• Some parsers used in seq(<tuple>) must now be mut
• Stream::peek_token, Stream::peek_slice, Stream::peek_finish no longer return a clone of Stream
• trait Locations functions have changed to improve parsing of lexed tokens
• ParserError::append and FromExternalError::from_external_errors kind parameter has been removed
• ParserError, AsChar, ContainsToken, Stream were added to the prelude
• Some trait bounds changed
• Deprecated functionality removed
• Deprecated escaped_transform in favor of the new name escaped

Features

• Decoupled ErrMode from the core traits through new ModalError trait and ParserError modal functions, allowing better performance and greater flexibility
• Add ParserError, AsChar, ContainsToken, Stream to the prelude
• Add stream::TokenSlice to help parsing of lexed tokens
• Implement ErrorConvert for ErrMode

Fixes

• Borrow parsers in seq!(<tuple>) so they can be used multiple times
• escaped and take_escaped now assert, rather than stop, on empty normal output
• Improve type inference for Parser::by_ref, Parser::complete_err
• Improve error reports for float
• Added an inherent ParserError::append to reduce boilerplate with custom errors
• Added support for TreeError with binary::bits parsers
• escaped can now have separate types for normal and escaped parsers

Documentation

• Modernized reference examples

Compatibility

• Deprecate ParserError::from_error_kind in favor of ParserError::from_input
• Deprecate InputError::new in favor of InputError::at
• Deprecate ErrorKind
  • If used as an error, consider EmptyError
  • For ParserError::append, just add an #[allow(deprecated)]

Features

• Add EmptyError which is like () but compatible with Parser::parse
• Add ParserError::from_input to help with the transition to 0.7
• Add InputError::at to help with the transition to 0.7

Compatibility

• Deprecated PResult in favor of ModalResult: v0.7 will make ErrMode optional and PResult will no longer be descriptive enough
• Deprecate IResult in favor of PResult<(I, O)>

Documentation

• Update comparison with nom

Fixes

• Ensure we append errors in repeat(_).fold(1..)

Fixes

• Add back in winnow::Located which was removed by accident

Compatibility

• stream::Located is deprecated in favor of stream::LocatingSlice
• combnator::rest is deprecated in favor of token::rest
• combnator::rest_len is deprecated in favor of token::rest_len
• combinator::<Struct> have mostly been deprecated in favor of combinator::impls::<Struct>
• unpeek is deprecated

Features

• Added repeat().try_fold() and repeat().verify_fold()

Fixes

• Respect is_partial in take_till

Performance

• More inlining

Documentation

• Clarify roles of peek and Parser::parse_peek
• Provide more context for people coming from nom

Internal

• Dependency update

Features

• Add Located::reset_to_start for parsing encoded graphs with start-relative pointers

Features

• Make Checkpoints comparable

Compatibility

• Deprecated Parser::recognize in favor of Parser::take
• Deprecated Parser::with_recognized in favor of Parser::taken

Fixes

• Renamed Parser::recognize to Parser::take to be consistent with other take parsers
• Renamed Parser::with_recognized to Parser::with_taken to be consistent with other take parsers

Fixes

• Removed unused I: Clone bound on Parser::parse

Documentation

• Expand on error reporting

Fixes

• Improve compilation errors when using non-parsers with seq! struct syntax

Fixes

• Remove AsBytes bounds, unblocking parsing frames of binary input

Features

• Extend seq! to constructing enum variants

Compatibility

• Bump MSRV to 1.65

Features

• Add Debug impls for stream::Stateful and stream::Recoverable

Features

• Support &mut [impl Parser] within alt

Fixes

• Improve debug traces when Input wrapper types are used

Fixes

• Add impl ErrorConvert for ContextError so it can be used with bit parsing

Compatibility

• Deprecated escaped in favor of take_escaped (rename)

Documentation

• Fix some bugs in concrete signatures
• Explain what "Partial version" means
• When discussing the signature, highlight the most relevant trait for input

Documentation

• Provide examples of concrete signatures

Fixes

• Make take_until("") consistent between simd or not, with or without empty buffer

Documentation

• Clarify generic and value parameters
• Cross reference *until and *till parsers
• (tutorial) Step through parts more slowly

Fixes

• Fix regression where dec_int / dec_uint didn't parse 0

Features

• Add support to take_until for char needles on &[u8] haystacks

Fixes

• Be consistent about inlining slice_len

Compatibility

• Deprecate token::tag for token::literal
• Deprecate binary::bits::tag for binary::bits::pattern

Features

• Allow a byte (u8) to be a tag

Fixes

• Clarify name of token::tag as token::literal
• Clarify name of binary::bits::tag as binary::bits::pattern

Features

• Initial support for error recovery behind unstable-recover feature

Compatibility

• Deprecate fold_repeat in favor of repeat().fold()

Features

• Add repeat().fold()

Compatibility

• Deprecate success(value) in favor of empty.value(value)
• Deprecated winnow::trace::trace in favor of the more centrally located winnow::combinator::trace
• Deprecated take_until0 / take_until1 in favor of take_until
• Deprecated repeat_till0 in favor of repeat_till
• Deprecated not_line_ending in favor of till_line_ending

Features

• Add more general empty combinator
• Added take_until that can handle any range of tokens to consume
• Added repeat_till that can handle any range of parsers to repeat

Documentation

• Made it easier to discover cut_err and how to use it
• Move trace documentation into the tutorial

Fixes

• Don't require Statefuls State to be clone (a leftover from pre &mut input)

Features

• Support char with tag parser which is faster than using one_of

Fixes

• Parse +/- inf/nan with ascii::float

Performance

• Help the optimizer trim unused instructions in any when parsing a complete buffer

Features

• Add Parser::default_value

Features

• New combinator::seq! for easier initialization of structs/tuples