Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a parser for flags formatted as bar-separated-values #297

Merged
merged 16 commits into from
Feb 8, 2023
Merged

Add a parser for flags formatted as bar-separated-values #297

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c88e58f
sketch out FromStr impls for flags types
KodrAus Feb 2, 2023
3d9a7af
work on serde formats and parsing
KodrAus Feb 2, 2023
e075f4d
move serde compat into an example
KodrAus Feb 2, 2023
eae62a1
avoid producing empty strings for empty flags
KodrAus Feb 2, 2023
b34d987
add some more tests for parsing and formatting
KodrAus Feb 2, 2023
f825817
use serde_test for testing derived serde impls
KodrAus Feb 2, 2023
38e65c1
allow empty strings in the Display fmt but keep 0x0 in Debug for empt…
KodrAus Feb 3, 2023
c63de2c
add some docs to the ParseError type
KodrAus Feb 3, 2023
00df59e
add some docs on the text grammar
KodrAus Feb 3, 2023
f860516
just rely on rustup in CI
KodrAus Feb 3, 2023
2233fac
yaml
KodrAus Feb 3, 2023
e7afc93
fix up by-ref for fields when std is enabled
KodrAus Feb 3, 2023
575236c
shift ParseError into parser module so it can be built out
KodrAus Feb 8, 2023
514952c
remove the serde legacy example
KodrAus Feb 8, 2023
3d4777a
move text grammar to the parser module
KodrAus Feb 8, 2023
bdd5f42
add some basic parsing and formatting benches
KodrAus Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
move text grammar to the parser module
  • Loading branch information
@KodrAus
KodrAus committed Feb 8, 2023
commit 3d4777af478738a1c074c543c9455270acf559ac
15 changes: 2 additions & 13 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,19 +271,8 @@
//! ## `Debug` and `Display`
//!
//! The `Debug` trait can be derived for a reasonable implementation. This library defines a standard
//! text-based representation for flags that generated flags types can use. It uses the following
//! whitespace and case insensitive grammar:
//!
//! - _Flags:_ (_Flag_)`|`*
//! - _Flag:_ _Identifier_ | _HexNumber_
//! - _Identifier:_ Any Rust identifier
//! - _HexNumber_: `0x`([0-9a-zA-Z])*
//!
//! As an example, this is how `Flags::A | Flags::B | 0x0c` can be represented as text:
//!
//! ```text
//! A | B | 0x0c
//! ```
//! text-based representation for flags that generated flags types can use. For details on the exact
//! grammar, see the [`parser`] module.
//!
//! ## `PartialEq` and `PartialOrd`
//!
Expand Down
14 changes: 14 additions & 0 deletions src/parser.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
//! Parsing flags from text.
//!
//! `bitflags` defines the following whitespace-insensitive grammar for flags formatted
//! as text:
//!
//! - _Flags:_ (_Flag_)`|`*
//! - _Flag:_ _Identifier_ | _HexNumber_
//! - _Identifier:_ Any Rust identifier
//! - _HexNumber_: `0x`([0-9a-zA-Z])*
//!
//! As an example, this is how `Flags::A | Flags::B | 0x0c` can be represented as text:
//!
//! ```text
//! A | B | 0x0c
//! ```

use core::fmt;

Expand Down