mirror of
https://gitee.com/openharmony/third_party_rust_nom
synced 2024-11-26 17:20:29 +00:00
Merge branch 'pxeger-main'
This commit is contained in:
commit
3ef4805b93
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
10
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -14,13 +14,13 @@ Please provide the following information with this pull request:
|
||||
|
||||
- related issue number (I need some context to understand a PR with a lot of
|
||||
code, except for documentation typos)
|
||||
- a test case reproducing the issue. You can write it in [issues.rs](https://github.com/Geal/nom/blob/master/tests/issues.rs)
|
||||
- a test case reproducing the issue. You can write it in [issues.rs](https://github.com/Geal/nom/blob/main/tests/issues.rs)
|
||||
- if adding a new combinator, please add code documentation and some unit tests
|
||||
in the same file. Also, please update the [combinator list](https://github.com/Geal/nom/blob/master/doc/choosing_a_combinator.md)
|
||||
in the same file. Also, please update the [combinator list](https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md)
|
||||
|
||||
## Code style
|
||||
|
||||
This project follows a [code style](https://github.com/Geal/nom/blob/master/rustfmt.toml)
|
||||
This project follows a [code style](https://github.com/Geal/nom/blob/main/rustfmt.toml)
|
||||
checked by [rustfmt][https://github.com/rust-lang-nursery/rustfmt].
|
||||
|
||||
Please avoid cosmetic fixes unrelated to the pull request. Keeping the changes
|
||||
@ -28,9 +28,9 @@ as small as possible increase your chances of getting this merged quickly.
|
||||
|
||||
## Rebasing
|
||||
|
||||
To make sure the changes will work properly once merged into the master branch
|
||||
To make sure the changes will work properly once merged into the main branch
|
||||
(which might have changed while you were working on your PR), please
|
||||
[rebase your PR on master](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
|
||||
[rebase your PR on main](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
|
||||
|
||||
## Squashing the commits
|
||||
|
||||
|
@ -851,7 +851,7 @@ Bugfix release
|
||||
|
||||
The 2.0 release is one of the biggest yet. It was a good opportunity to clean up some badly named combinators and fix invalid behaviours.
|
||||
|
||||
Since this version introduces a few breaking changes, an [upgrade documentation](https://github.com/Geal/nom/blob/master/doc/upgrading_to_nom_2.md) is available, detailing the steps to fix the most common migration issues. After testing on a set of 30 crates, most of them will build directly, a large part will just need to activate the "verbose-errors" compilation feature. The remaining fixes are documented.
|
||||
Since this version introduces a few breaking changes, an [upgrade documentation](https://github.com/Geal/nom/blob/main/doc/upgrading_to_nom_2.md) is available, detailing the steps to fix the most common migration issues. After testing on a set of 30 crates, most of them will build directly, a large part will just need to activate the "verbose-errors" compilation feature. The remaining fixes are documented.
|
||||
|
||||
This version also adds a lot of interesting features, like the permutation combinator or whitespace separated formats support.
|
||||
|
||||
|
@ -126,7 +126,7 @@ path = "examples/string.rs"
|
||||
|
||||
[badges]
|
||||
travis-ci = { repository = "Geal/nom" }
|
||||
coveralls = { repository = "Geal/nom", branch = "master", service = "github" }
|
||||
coveralls = { repository = "Geal/nom", branch = "main", service = "github" }
|
||||
maintenance = { status = "actively-developed" }
|
||||
|
||||
[workspace]
|
||||
|
10
README.md
10
README.md
@ -3,7 +3,7 @@
|
||||
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
|
||||
[![Join the chat at https://gitter.im/Geal/nom](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Geal/nom?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[![Build Status](https://github.com/Geal/nom/actions/workflows/ci.yml/badge.svg)](https://github.com/Geal/nom/actions/workflows/ci.yml)
|
||||
[![Coverage Status](https://coveralls.io/repos/github/Geal/nom/badge.svg?branch=master)](https://coveralls.io/github/Geal/nom?branch=master)
|
||||
[![Coverage Status](https://coveralls.io/repos/github/Geal/nom/badge.svg?branch=main)](https://coveralls.io/github/Geal/nom?branch=main)
|
||||
[![Crates.io Version](https://img.shields.io/crates/v/nom.svg)](https://crates.io/crates/nom)
|
||||
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.48.0+-lightgray.svg)](#rust-version-requirements)
|
||||
|
||||
@ -13,7 +13,7 @@ that end, it uses extensively Rust's *strong typing* and *memory safety* to prod
|
||||
fast and correct parsers, and provides functions, macros and traits to abstract most of the
|
||||
error prone plumbing.
|
||||
|
||||
![nom logo in CC0 license, by Ange Albertini](https://raw.githubusercontent.com/Geal/nom/master/assets/nom.png)
|
||||
![nom logo in CC0 license, by Ange Albertini](https://raw.githubusercontent.com/Geal/nom/main/assets/nom.png)
|
||||
|
||||
*nom will happily take a byte out of your files :)*
|
||||
|
||||
@ -74,8 +74,8 @@ fn parse_color() {
|
||||
## Documentation
|
||||
|
||||
- [Reference documentation](https://docs.rs/nom)
|
||||
- [Various design documents and tutorials](https://github.com/Geal/nom/tree/master/doc)
|
||||
- [List of combinators and their behaviour](https://github.com/Geal/nom/blob/master/doc/choosing_a_combinator.md)
|
||||
- [Various design documents and tutorials](https://github.com/Geal/nom/tree/main/doc)
|
||||
- [List of combinators and their behaviour](https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md)
|
||||
|
||||
If you need any help developing your parsers, please ping `geal` on IRC (libera, geeknode, oftc), go to `#nom-parsers` on Libera IRC, or on the [Gitter chat room](https://gitter.im/Geal/nom).
|
||||
|
||||
@ -230,7 +230,7 @@ Here is a (non exhaustive) list of known projects using nom:
|
||||
[CSV](https://github.com/GuillaumeGomez/csv-parser),
|
||||
[FASTA](https://github.com/TianyiShi2001/nom-fasta),
|
||||
[FASTQ](https://github.com/elij/fastq.rs),
|
||||
[INI](https://github.com/Geal/nom/blob/master/tests/ini.rs),
|
||||
[INI](https://github.com/Geal/nom/blob/main/tests/ini.rs),
|
||||
[ISO 8601 dates](https://github.com/badboy/iso8601),
|
||||
[libconfig-like configuration file format](https://github.com/filipegoncalves/rust-config),
|
||||
[Web archive](https://github.com/sbeckeriv/warc_nom_parser),
|
||||
|
@ -12,7 +12,7 @@ If you got the following error when compiling your nom parser:
|
||||
error[E0425]: cannot find value `INVALID_NOM_SYNTAX_PLEASE_SEE_FAQ` in this scope
|
||||
--> src/lib.rs:111:7
|
||||
|
|
||||
111 | INVALID_NOM_SYNTAX_PLEASE_SEE_FAQ //https://github.com/Geal/nom/blob/master/doc/FAQ.md#using-nightly-to-get-better-error-messages
|
||||
111 | INVALID_NOM_SYNTAX_PLEASE_SEE_FAQ //https://github.com/Geal/nom/blob/main/doc/archive/FAQ.md#using-nightly-to-get-better-error-messages
|
||||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ not found in this scope
|
||||
```
|
||||
|
||||
|
@ -51,7 +51,7 @@ fn parse_status(i: &[u8]) -> IResult<&[u8], Status>
|
||||
|
||||
# Producers and consumers
|
||||
|
||||
The old implementation was not flexible, and a bit slow (because of allocations). The new implementation can be driven more precisely outside of the consumer, step by step if needed, can return a result, has custom error types, and can combine consumers. You can see [an example in the repository](https://github.com/Geal/nom/blob/master/tests/omnom.rs#).
|
||||
The old implementation was not flexible, and a bit slow (because of allocations). The new implementation can be driven more precisely outside of the consumer, step by step if needed, can return a result, has custom error types, and can combine consumers. You can see [an example in the repository](https://github.com/Geal/nom/blob/1.0/tests/omnom.rs#).
|
||||
|
||||
# Changes around `Incomplete`
|
||||
|
||||
|
@ -142,7 +142,7 @@ input text that was parsed, which in this case is the entire `&str` `hello_world
|
||||
|
||||
### Escaped Strings
|
||||
|
||||
This is [one of the examples](https://github.com/Geal/nom/blob/master/examples/string.rs) in the
|
||||
This is [one of the examples](https://github.com/Geal/nom/blob/main/examples/string.rs) in the
|
||||
examples directory.
|
||||
|
||||
### Integers
|
||||
|
16
src/lib.rs
16
src/lib.rs
@ -52,16 +52,16 @@
|
||||
//!
|
||||
//! The code is available on [Github](https://github.com/Geal/nom)
|
||||
//!
|
||||
//! There are a few [guides](https://github.com/Geal/nom/tree/master/doc) with more details
|
||||
//! about [how to write parsers](https://github.com/Geal/nom/blob/master/doc/making_a_new_parser_from_scratch.md),
|
||||
//! or the [error management system](https://github.com/Geal/nom/blob/master/doc/error_management.md).
|
||||
//! There are a few [guides](https://github.com/Geal/nom/tree/main/doc) with more details
|
||||
//! about [how to write parsers](https://github.com/Geal/nom/blob/main/doc/making_a_new_parser_from_scratch.md),
|
||||
//! or the [error management system](https://github.com/Geal/nom/blob/main/doc/error_management.md).
|
||||
//! You can also check out the [recipes] module that contains examples of common patterns.
|
||||
//!
|
||||
//! **Looking for a specific combinator? Read the
|
||||
//! ["choose a combinator" guide](https://github.com/Geal/nom/blob/master/doc/choosing_a_combinator.md)**
|
||||
//! ["choose a combinator" guide](https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md)**
|
||||
//!
|
||||
//! If you are upgrading to nom 5.0, please read the
|
||||
//! [migration document](https://github.com/Geal/nom/blob/master/doc/upgrading_to_nom_5.md).
|
||||
//! [migration document](https://github.com/Geal/nom/blob/main/doc/upgrading_to_nom_5.md).
|
||||
//!
|
||||
//! ## Parser combinators
|
||||
//!
|
||||
@ -167,8 +167,8 @@
|
||||
//! - An error `Err(Err::Incomplete(Needed))` indicating that more input is necessary. `Needed` can indicate how much data is needed
|
||||
//! - An error `Err(Err::Failure(c))`. It works like the `Error` case, except it indicates an unrecoverable error: We cannot backtrack and test another parser
|
||||
//!
|
||||
//! Please refer to the ["choose a combinator" guide](https://github.com/Geal/nom/blob/master/doc/choosing_a_combinator.md) for an exhaustive list of parsers.
|
||||
//! See also the rest of the documentation [here](https://github.com/Geal/nom/blob/master/doc).
|
||||
//! Please refer to the ["choose a combinator" guide](https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md) for an exhaustive list of parsers.
|
||||
//! See also the rest of the documentation [here](https://github.com/Geal/nom/blob/main/doc).
|
||||
//!
|
||||
//! ## Making new parsers with function combinators
|
||||
//!
|
||||
@ -369,7 +369,7 @@
|
||||
//! // while the complete version knows that all of the data is there
|
||||
//! assert_eq!(alpha0_complete("abcd"), Ok(("", "abcd")));
|
||||
//! ```
|
||||
//! **Going further:** Read the [guides](https://github.com/Geal/nom/tree/master/doc),
|
||||
//! **Going further:** Read the [guides](https://github.com/Geal/nom/tree/main/doc),
|
||||
//! check out the [recipes]!
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
#![cfg_attr(feature = "cargo-clippy", allow(clippy::doc_markdown))]
|
||||
|
Loading…
Reference in New Issue
Block a user