If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using a local clone.

dmd.common.bitfields

A library bitfields utility

Authors:

Dennis Korpel

License:

Boost License 1.0

Source common/bitfields.d

Documentation https://dlang.org/phobos/dmd_common_bitfields.html

Coverage https://codecov.io/gh/dlang/dmd/src/master/src/dmd/common/bitfields.d

string generateBitFields(S, T)() if (__traits(isUnsigned, T));

Generate code for bit fields inside a struct/class body

Parameters:

S	type of a struct with only boolean fields, which should become bit fields
T	type of bit fields variable, must have enough bits to store all booleans

Returns:

D code with a bit fields variable and getter / setter functions

Examples:

static struct B
{
    bool x;
    bool y;
    bool z = 1;
}

static struct S
{
    mixin(generateBitFields!(B, ubyte));
}

S s;
assert(!s.x);
s.x = true;
assert(s.x);
s.x = false;
assert(!s.x);

s.y = true;
assert(s.y);
assert(!s.x);
assert(s.z);

Library Reference

dmd.common.bitfields