Skip to main content

SparseList

Struct SparseList 

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

A list with a maximum length of N that exposes its tree structure for sparse fill-in: materialized indices, cached subtree roots, or implicit zero-hashes for never-written regions.

Hash is byte-identical to a fully-materialised List<T, N> with the same effective contents.

Implementations§

Source§

impl<T, const N: u64> SparseList<T, N>

Source

pub fn new() -> Self

Build an empty sparse list.

Source

pub fn len(&self) -> u64

Logical length.

Source

pub fn is_empty(&self) -> bool

true iff no entries are present and len == 0.

Source

pub fn iter(&self) -> impl Iterator<Item = (u64, &MissingOr<T>)>

Iterator over (index, MissingOr<T>) for materialized entries only.

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = (u64, &mut MissingOr<T>)>

Mutable iterator over (index, &mut MissingOr<T>) for materialized entries only. Used by callers that need to rewrite entry values in place (e.g., resolving Ref targets to Hash after settle).

Source

pub fn entries_count(&self) -> usize

Number of materialized entries. Distinct from len, which is the logical length (max index + 1).

Source

pub fn get(&self, idx: u64) -> Option<&MissingOr<T>>

Look up a single entry by leaf index. O(log n).

Source

pub fn insert( &mut self, idx: u64, value: MissingOr<T>, ) -> Result<(), DecodeError>

Insert a materialized entry. Updates len to max(len, idx + 1). O(n) — sorted shift on insert. If idx is already present, the existing value is overwritten (matching BTreeMap::insert semantics).

Source

pub fn remove(&mut self, idx: u64) -> Option<MissingOr<T>>

Remove the entry at idx, returning its previous value if any. Does not decrement len — the logical length is independent of which indices are materialized.

Source

pub fn set_len(&mut self, len: u64) -> Result<(), DecodeError>

Set the logical length explicitly (does not affect entries).

Source

pub fn cache_subtree_root(&mut self, depth: usize, idx: u64, root: [u8; 32])

Cache a precomputed subtree root at tree position (depth, idx). depth == 0 corresponds to the root; deeper means closer to leaves. O(n) — sorted insert into cached_subtree_roots.

Source

pub fn cached_subtree_roots_count(&self) -> usize

Number of cached subtree roots. Used by fmt::Debug.

Source

pub fn cached_subtree_roots(&self) -> impl Iterator<Item = (u64, &[u8; 32])>

Iterator over cached subtree roots in sorted-by-key order.

Trait Implementations§

Source§

impl<T: Clone, const N: u64> Clone for SparseList<T, 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<T: Debug, const N: u64> Debug for SparseList<T, N>

Source§

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

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

impl<T: Decode, const N: u64> Decode for SparseList<T, 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<T, const N: u64> Default for SparseList<T, N>

Source§

fn default() -> Self

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

impl<T: Encode, const N: u64> Encode for SparseList<T, 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<T: HashTreeRoot + Encode, const N: u64> HashTreeRoot for SparseList<T, 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<T: PartialEq, const N: u64> PartialEq for SparseList<T, 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<T: Eq, const N: u64> Eq for SparseList<T, N>

Auto Trait Implementations§

§

impl<T, const N: u64> Freeze for SparseList<T, N>

§

impl<T, const N: u64> RefUnwindSafe for SparseList<T, N>
where T: RefUnwindSafe,

§

impl<T, const N: u64> Send for SparseList<T, N>
where T: Send,

§

impl<T, const N: u64> Sync for SparseList<T, N>
where T: Sync,

§

impl<T, const N: u64> Unpin for SparseList<T, N>
where T: Unpin,

§

impl<T, const N: u64> UnsafeUnpin for SparseList<T, N>

§

impl<T, const N: u64> UnwindSafe for SparseList<T, N>
where T: UnwindSafe,

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.