Struct ink_storage::collections::BitStash

pub struct BitStash { /* private fields */ }

A stash for bits operating on the contract storage.

Allows to efficiently put and take bits and stores the underlying bits in an extremely compressed format.

Implementations

impl BitStash

pub fn new() -> Self

Creates a new storage bit stash.

pub fn get(&self, index: u32) -> Option<bool>

Returns true if the bit at the indexed slot is set (1).

Returns None if the index is out of bounds.

pub fn put(&mut self) -> u32

Puts another set bit into the storage bit stash.

Returns the index to the slot where the set bit has been inserted.

pub fn take(&mut self, index: u32) -> Option<bool>

Takes the bit from the given index and returns it.

Returns true if the indexed bit was set (1). Returns None if the index is out of bounds.

Note

This frees up the indexed slot for putting in another set bit.

Trait Implementations

impl Debug for BitStash

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BitStash

fn default() -> BitStash

Returns the “default value” for a type.

impl PartialEq<BitStash> for BitStash

fn eq(&self, other: &BitStash) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BitStash) -> bool

This method tests for !=.

impl SpreadAllocate for BitStash

fn allocate_spread(ptr: &mut KeyPtr) -> Self

Default initializes the implementing type using spread layout.

impl SpreadLayout for BitStash

const FOOTPRINT: u64

The footprint of the type.

fn pull_spread(ptr: &mut KeyPtr) -> Self

Pulls an instance of Self from the contract storage.

fn push_spread(&self, ptr: &mut KeyPtr)

Pushes an instance of Self to the contract storage.

fn clear_spread(&self, ptr: &mut KeyPtr)

Clears an instance of Self from the contract storage.

const REQUIRES_DEEP_CLEAN_UP: bool

Indicates whether a type requires deep clean-up of its state meaning that a clean-up routine has to decode an entity into an instance in order to eventually recurse upon its tear-down. This is not required for the majority of primitive data types such as i32, however types such as storage::Box that might want to forward the clean-up procedure to their inner T require a deep clean-up.

impl StorageLayout for BitStash

fn layout(key_ptr: &mut KeyPtr) -> Layout

Returns the static storage layout of Self.

impl Eq for BitStash

impl StructuralEq for BitStash

impl StructuralPartialEq for BitStash