BitKeeper

Undocumented in source.

struct BitKeeper {

this(this);

this(ubyte[] bytes, size_t maxBitsToUse);

SimpleResult!BitKeeperSlice alloc(size_t bitCount);

void free(BitKeeperSlice slice);

size_t capacityInBits();

size_t lengthInBits();

}

Constructors

this this(ubyte[] bytes, size_t maxBitsToUse): Undocumented in source.

Postblit

this(this) this(this): Undocumented in source.

Members

Functions

alloc SimpleResult!BitKeeperSlice alloc(size_t bitCount): Undocumented in source. Be warned that the author may not have intended to support it.
capacityInBits size_t capacityInBits(): Undocumented in source. Be warned that the author may not have intended to support it.
free void free(BitKeeperSlice slice): Undocumented in source. Be warned that the author may not have intended to support it.
lengthInBits size_t lengthInBits(): Undocumented in source. Be warned that the author may not have intended to support it.

Examples

ubyte[3] buffer;
auto bits = BitKeeper(buffer[0..$], 3*8);

// NOTE: User code can't manually create BitKeeperSlices like the unittest can.

// Single-byte
assert(bits.alloc(1).assumeValid == BitKeeperSlice(0, 0, 1));
assert(buffer[0] == 1);
bits.free(BitKeeperSlice(0, 0, 1));
assert(buffer[0] == 0);
assert(bits.alloc(1).assumeValid == BitKeeperSlice(0, 0, 1));
assert(bits.alloc(3).assumeValid == BitKeeperSlice(0, 1, 3));
assert(buffer[0] == 0b0000_1111);
bits.free(BitKeeperSlice(0, 1, 2));
assert(buffer[0] == 0b0000_1001);
assert(bits.alloc(1).assumeValid == BitKeeperSlice(0, 1, 1));
assert(bits.alloc(2).assumeValid == BitKeeperSlice(0, 4, 2));
assert(buffer[0] == 0b0011_1011);
buffer[0] = 0;

// Two bytes
assert(bits.alloc(7).assumeValid == BitKeeperSlice(0, 0, 7));
assert(bits.alloc(3).assumeValid == BitKeeperSlice(0, 7, 3));
assert(buffer[0] == 0xFF);
assert(buffer[1] == 0b0000_0011);
bits.free(BitKeeperSlice(0, 7, 2));
assert(buffer[0] == 0b0111_1111);
assert(buffer[1] == 0b0000_0010);
assert(bits.alloc(3).assumeValid == BitKeeperSlice(1, 2, 3));
assert(buffer[0] == 0b0111_1111);
assert(buffer[1] == 0b0001_1110);
buffer[0..2] = 0;

// Multi-byte
assert(bits.alloc(18).assumeValid == BitKeeperSlice(0, 0, 18));
assert(buffer[0] == 0xFF);
assert(buffer[1] == 0xFF);
assert(buffer[2] == 0b0000_0011);
bits.free(BitKeeperSlice(0, 0, 18));
assert(buffer[0] == 0);
assert(buffer[1] == 0);
assert(buffer[2] == 0);

BitKeeper

Constructors

Postblit

Members

Functions

Examples

Meta

Source