Skip to main content

Bitlist

Struct Bitlist 

Source
pub struct Bitlist<const N: u64> { /* private fields */ }
Expand description

SSZ Bitlist with a compile-time bit cap of N.

Wire format: packed bits (LSB-first within bytes), followed by a sentinel 1 bit immediately after the data bits. The sentinel marks the end of the logical bitstream and is not part of the bit content.

Implementations§

Source§

impl<const N: u64> Bitlist<N>

Source

pub fn new() -> Self

Build an empty bitlist.

Source

pub fn from_bits(bits: &[bool]) -> Result<Self, DecodeError>

Build from a logical bit vector.

Source

pub fn len(&self) -> u64

Logical bit length.

Source

pub fn is_empty(&self) -> bool

true iff there are no bits.

Source

pub fn get(&self, i: u64) -> Option<bool>

Get bit i. Returns None if i >= len.

Source

pub fn data_bytes(&self) -> &[u8]

Borrow the raw packed data bytes (without the sentinel layer).

Trait Implementations§

Source§

impl<const N: u64> Clone for Bitlist<N>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<const N: u64> Debug for Bitlist<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: u64> Decode for Bitlist<N>

Source§

fn is_ssz_fixed_len() -> bool

true iff this type is fixed-length.
Source§

fn ssz_fixed_len() -> usize

Number of bytes this type occupies in the fixed-length portion of a container encoding. Variable-length types return BYTES_PER_LENGTH_OFFSET.
Source§

fn from_ssz_bytes(bytes: &[u8]) -> Result<Self, DecodeError>

Decode a full instance from bytes, rejecting trailing input.
Source§

impl<const N: u64> Default for Bitlist<N>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const N: u64> Encode for Bitlist<N>

Source§

fn is_ssz_fixed_len() -> bool

true iff this type is fixed-length (no variable-length fields).
Source§

fn ssz_fixed_len() -> usize

Number of bytes this type occupies in the fixed-length portion of a container encoding. For variable-length types this returns BYTES_PER_LENGTH_OFFSET (i.e. the size of the offset slot).
Source§

fn ssz_bytes_len(&self) -> usize

Total size of self when serialized.
Source§

fn ssz_append(&self, buf: &mut Vec<u8>)

Append the encoding of self to buf.
Source§

fn is_basic_type() -> bool

true for “basic” SSZ types (uintN, bool), which pack adjacent elements into shared 32-byte chunks for merkleization. Composite types (containers, lists, structs) return false (the default).
Source§

fn as_ssz_bytes(&self) -> Vec<u8>

Serialize into a fresh Vec<u8> allocated through the global allocator.
Source§

impl<const N: u64> HashTreeRoot for Bitlist<N>

Source§

fn hash_tree_root<D: Digest<OutputSize = U32>>(&self) -> [u8; 32]

Compute the hash tree root using D as the underlying hash.
Source§

impl<const N: u64> PartialEq for Bitlist<N>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<const N: u64> Eq for Bitlist<N>

Auto Trait Implementations§

§

impl<const N: u64> Freeze for Bitlist<N>

§

impl<const N: u64> RefUnwindSafe for Bitlist<N>

§

impl<const N: u64> Send for Bitlist<N>

§

impl<const N: u64> Sync for Bitlist<N>

§

impl<const N: u64> Unpin for Bitlist<N>

§

impl<const N: u64> UnsafeUnpin for Bitlist<N>

§

impl<const N: u64> UnwindSafe for Bitlist<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.