#getter-setter #automatic #single #field #multiple #bitflags #bools

macro bool_to_bitflags

A library to compact multiple bools into a single bitflags field automatically with getters and setters

3 releases

new 0.1.2 May 14, 2024
0.1.1 Apr 2, 2024
0.1.0 Jan 3, 2024

#301 in Procedural macros

Download history 374/week @ 2024-01-25 197/week @ 2024-02-01 361/week @ 2024-02-08 222/week @ 2024-02-15 88/week @ 2024-02-22 212/week @ 2024-02-29 459/week @ 2024-03-07 436/week @ 2024-03-14 234/week @ 2024-03-21 473/week @ 2024-03-28 188/week @ 2024-04-04 174/week @ 2024-04-11 314/week @ 2024-04-18 301/week @ 2024-04-25 346/week @ 2024-05-02 190/week @ 2024-05-09

1,176 downloads per month

MIT license

29KB
668 lines

Bool To Bitflags

A library to compact multiple bools into a single bitflags field automatically with getters and setters.

See the documentation on docs.rs.


lib.rs:

bool-to-bitflags

A struct attribute macro to pack structs with multiple boolean fields into efficent byte packing.

This macro will make struct fields of type bool and Option<bool> be packed into a field called __generated_flags.

This field is responsible for storing the packed bits, and should not be messed with manually, other than to initialize as all-false with {StructName}GeneratedFlags::empty() or all-true with {StructName}GeneratedFlags::all().

Arguments

Argument Name Type Default Value Description
getter_prefix String The prefix before getter names
setter_prefix String set_ The prefix before setter names
private_getters bool Field Visibility If true, getters are forced to be crate-private
private_setters bool Field Visibility If true, setters are forced to be crate-private
document_setters bool false If true, field documentation is used for setters, instead of getters
owning_setters bool false If true, setters take self and return self instead of taking &mut self

MSRV

The Minimum Supported Rust Version of this crate is 1.65.

It is considered a breaking change to raise this requirement.

Dependencies

~0.8–1.5MB
~31K SLoC