Bitmap

BitMaps pack 256 booleans across each bit of a single 256-bit slot of uint256 type. Hence booleans corresponding to 256 sequential indices would only consume a single slot, unlike the regular bool which would consume an entire slot for a single value.

Structs

Bitmap

struct Bitmap has key, store {
    id: UID
}

The module adds dynamic fields to the Bitmap.

Interface

new

Creates a Bitmap.

public fun new(ctx: &mut TxContext): Bitmap

• @return AcCollection. Bitmap.

get

Checks if an indexis set to true or false in the map.

public fun get(self: &Bitmap, index: u256): bool

• @param self: A reference to the Bitmap.

• @param index: The slot to check if it is flagged.

• @return bool. If the index is true or false.

set

Sets the slot index to true in self.

public fun set(self: &mut Bitmap, index: u256)

• @param self: A reference to the Bitmap.

• @param index: The slot we will set to true.

unset

Sets the slot index to false in self.

public fun set(self: &mut Bitmap, index: u256)

• @param self: A reference to the Bitmap.

• @param index: The slot we will set to false.

destroy

Destroys the self.

public fun destroy(self: Bitmap)

• @param self: self A bitmap to destroy.