diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-30 18:31:36 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-30 18:31:36 +0000 |
| commit | e02c5b5930c2c9ba3e5423fe12e2ef0155017297 (patch) | |
| tree | fd60ebbbb5299e16e5fca8c773ddb74f764760db /vendor/bitflags/README.md | |
| parent | Adding debian version 1.73.0+dfsg1-1. (diff) | |
| download | rustc-e02c5b5930c2c9ba3e5423fe12e2ef0155017297.tar.xz rustc-e02c5b5930c2c9ba3e5423fe12e2ef0155017297.zip | |
Merging upstream version 1.74.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/bitflags/README.md')
| -rw-r--r-- | vendor/bitflags/README.md | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/vendor/bitflags/README.md b/vendor/bitflags/README.md index d604d48d5..39224533d 100644 --- a/vendor/bitflags/README.md +++ b/vendor/bitflags/README.md @@ -6,9 +6,20 @@ bitflags [](https://docs.rs/bitflags)  -A Rust macro to generate structures which behave like a set of bitflags +`bitflags` generates flags enums with well-defined semantics and ergonomic end-user APIs. + +You can use `bitflags` to: + +- provide more user-friendly bindings to C APIs where flags may or may not be fully known in advance. +- generate efficient options types with string parsing and formatting support. + +You can't use `bitflags` to: + +- guarantee only bits corresponding to defined flags will ever be set. `bitflags` allows access to the underlying bits type so arbitrary bits may be set. +- define bitfields. `bitflags` only generates types where set bits denote the presence of some combination of flags. - [Documentation](https://docs.rs/bitflags) +- [Specification](https://github.com/bitflags/bitflags/blob/main/spec.md) - [Release notes](https://github.com/bitflags/bitflags/releases) ## Usage @@ -17,7 +28,7 @@ Add this to your `Cargo.toml`: ```toml [dependencies] -bitflags = "2.3.3" +bitflags = "2.4.0" ``` and this to your source code: |