Struct ink_storage::collections::Bitvec

pub struct Bitvec { /* fields omitted */ }

A storage bit vector.

Note

Organizes its bits in chunks of 256 bits. Allows to push, pop, inspect and manipulate the underlying bits.

Implementations

impl Bitvec

pub fn new() -> Self

Creates a new empty bit vector.

pub fn len(&self) -> u32

Returns the length of the bit vector in bits.

pub fn is_empty(&self) -> bool

Returns true if the bit vector is empty.

pub fn capacity(&self) -> u64

Returns the capacity of the bit vector in bits.

Note

Returns a u64 since it is always greater than or equal to self.len() which itself returns a u32.

pub fn bits(&self) -> BitsIter<'_>

Returns an iterator over the bits of the storage bit vector.

pub fn bits_mut(&mut self) -> BitsIterMut<'_>

Returns an iterator over the mutable bits of the storage bit vector.

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

Returns the value of the bit at the given index if any.

pub fn get_mut(&mut self, at: u32) -> Option<BitRefMut<'_>>

Returns a mutable bit access to the bit at the given index if any.

pub fn get_chunk(&self, at: u32) -> Option<ChunkRef<&Bits256>>

Returns a shared reference to the 256-bit chunk for the bit at the given index.

pub fn get_chunk_mut(&mut self, at: u32) -> Option<ChunkRef<&mut Bits256>>

Returns an exclusive reference to the 256-bit chunk for the bit at the given index.

pub fn first(&self) -> Option<bool>

Returns the first bit of the bit vector.

Note

Returns None if the bit vector is empty.

pub fn first_mut(&mut self) -> Option<BitRefMut<'_>>

Returns a mutable bit access to the first bit of the bit vector.

Note

Returns None if the bit vector is empty.

pub fn last(&self) -> Option<bool>

Returns the last bit of the bit vector.

Note

Returns None if the bit vector is empty.

pub fn last_mut(&mut self) -> Option<BitRefMut<'_>>

Returns a mutable bit access to the last bit of the bit vector.

Note

Returns None if the bit vector is empty.

pub fn push(&mut self, value: bool)

Pushes the given value onto the bit vector.

Note

This increases the length of the bit vector.

Panics

If the storage bit vector reached its maximum capacity.

pub fn pop(&mut self) -> Option<bool>

Pops the last bit from the bit vector.

Returns the popped bit as bool.

Note

This reduces the length of the bit vector by one.

Trait Implementations

impl Debug for Bitvec

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

Formats the value using the given formatter.

impl Default for StorageBitvec

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StorageBitvec

impl<'a> Extend<&'a bool> for StorageBitvec

fn extend<T: IntoIterator<Item = &'a bool>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<bool> for StorageBitvec

fn extend<T: IntoIterator<Item = bool>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> FromIterator<&'a bool> for StorageBitvec

fn from_iter<T: IntoIterator<Item = &'a bool>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<bool> for StorageBitvec

fn from_iter<T: IntoIterator<Item = bool>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a StorageBitvec

type Item = bool

The type of the elements being iterated over.

type IntoIter = BitsIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Bitvec> for StorageBitvec

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl SpreadLayout for StorageBitvec

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 StorageBitvec

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

Returns the static storage layout of Self.