bitflags-lite 0.3.0

Lightweight generics-based bitflags
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.3.0] - 2026-10-17
### Added
- Methods `BitFlag::mask_or_empty` and `BitFlagExt::mask_or_default`.

### Changed
- Improved clarity of README and docs main page.

### Removed
- Methods `BitFlag::mask_or_default` and `BitFlagExt::mask_or_default`.

## [0.2.0] - 2026-10-16
### Added
- `bitflags!` macro for defining a flag set from a compact declaration.
  The macro generates a [`BitFlagsSpec`] implementation and named
  constants for individual bits and masks. It does not generate a new
  type: every flag set remains a `BitFlags<T, U>` over a user-defined
  tag. Type aliases for `BitFlags<T, U>` and `BitFlag<T, U>` are written
  by the user next to the macro invocation.
- `BitFlagsSpec::COMBINED_NAMES` associated const for names that parse to
  multi-bit values. Combined names are consulted by parsers but not by
  `Display`, which always writes the union of individual flag names.

## [0.1.0] - 2026-10-15
### Added
- `BitFlagsSpec<T>` trait for defining valid bits, flag names, and the
  default name matcher for a flag set.
- `NameMatcher` enum for exact and ASCII case-insensitive name matching.
- `BitFlags<T, U>` and `BitFlag<T, U>` types, tagged by a user-defined
  spec type `U` and stored in an integer `T`.
- `BitFlagsIter<T, U>` iterator over the set bits of a `BitFlags`.
- `BitFlagsExt<T, U>` and `BitFlagExt<T, U>` extension traits providing
  generic versions of the const methods on the concrete integer impls.
- Parse, format, and conversion APIs, including:
  - `TryFrom<BitFlags<T, U>> for BitFlag<T, U>` and
    `BitFlag::try_from_flags`.
  - `FromStr` for `BitFlags` and `BitFlag`.
  - `Display` with named-flag and hexadecimal output, `Debug`, `Binary`,
    `Octal`, `LowerHex`, and `UpperHex`.
- Standard comparison and hash trait implementations.
- `From`, `IntoIterator`, `Extend`, `FromIterator`.
- Error types: `BitFlagsParseError`, `BitFlagParseError`,
  `BitFlagParseNameError`, `BitFlagParseHexError`, and
  `BitFlagFromFlagsError`.
- Optional integrations: `arbitrary`, `serde`, and `bytemuck`.
- `no_std` and `no_alloc` support.

[Unreleased]: https://github.com/zheland/bitflags-lite/compare/v0.3.0...HEAD
[0.3.0]: https://github.com/zheland/bitflags-lite/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/zheland/bitflags-lite/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/zheland/bitflags-lite/compare/v0.0.0...v0.1.0