Skip to content

Commit 156e9c3

Browse files
committed
Add short feature description
1 parent 34cec17 commit 156e9c3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,12 @@ convenience macro `FromPrimitive`) to interoperate with low level, typically ope
55
related types which store data with sub-byte precision, like boolean flags or sub-byte fields,
66
in a type-safe, typical rust way.
77

8+
It supports:
9+
- `bool`s and C-like enums as bit flags + enumerability over flags, if C-like enums are used
10+
- Primitive types and C-like enums as multi-bit fields
11+
- Explicit and implicit positioning and sizing of fields and flags
12+
- Optional `core::fmt::Debug` and `core::fmt::Display` implementations
13+
- Compile-time overlap and boundary checking.
14+
815
For more specific documentation look at the documentation of the macros, or at the files in
9-
`examples/*`.
16+
`examples/*`.

0 commit comments

Comments
 (0)