Lib.rs

› Development tools › Procedural macros
#bit-flags #automatic #getter-setter

macro bool_to_bitflags

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

by Gnome!

4 releases

0.1.3 Jun 22, 2024
0.1.2 May 14, 2024
0.1.1 Apr 2, 2024
0.1.0 Jan 3, 2024

#361 in Procedural macros

Download history 44/week @ 2024-07-02 92/week @ 2024-07-09 106/week @ 2024-07-16 63/week @ 2024-07-23 205/week @ 2024-07-30 271/week @ 2024-08-06 167/week @ 2024-08-13 171/week @ 2024-08-20 142/week @ 2024-08-27 204/week @ 2024-09-03 194/week @ 2024-09-10 118/week @ 2024-09-17 118/week @ 2024-09-24 238/week @ 2024-10-01 147/week @ 2024-10-08 203/week @ 2024-10-15

752 downloads per month

MIT license

29KB
672 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.7–1.4MB
~30K SLoC