Skip to main content

CNodeCap

Struct CNodeCap 

Source
pub struct CNodeCap<O = Box<Cap>> {
    pub slots: CNodeSlots<O>,
}
Expand description

CNode cap: a sparse, direct Key -> CapHashOrRef<O> map.

rkyv (the wire form) is derived; the derive adds a slots: Archive field bound, which for the wire payload resolves via CapHashOrRef<Box<Cap>>: Archive (gated on Box<Cap>: WireOwned, a leaf marker — no recursion into Cap: Archive). A non-wire payload such as Box<CachedCap> does not satisfy the field bound, so a CNodeCap<Box<CachedCap>> has no rkyv impl and cannot cross the wire — non-serialisable by construction. Clone / Debug / Default / HashTreeRoot are hand-rolled with payload-specific bounds (a blanket derive would over-constrain Box<Cap>, which is not Default, and ssz_derive::HashTreeRoot adds no bound at all, so it would not compile for a generic field).

Fields§

§slots: CNodeSlots<O>

Sparse slot table keyed by logical Key. Absent keys are empty; a Missing(h) entry substitutes losslessly for the value rooting at h.

Implementations§

Source§

impl<O> CNodeCap<O>

Source

pub fn new() -> Self

Construct an empty CNode (no slots). A CNode grows on demand and is bounded by storage quota, not a fixed slot count.

Source

pub fn commitment_key(key: &Key) -> [u8; 32]

Commitment radix key for a logical key: Hasher(key).

This is intentionally not used by ordinary get / set / take.

Source

pub fn peek_key(&self, k: &[u8]) -> Option<&CapHashOrRef<O>>

Borrow the cap bound to logical key k without cloning — the read-only peek used to inspect an Owned cap (e.g. read a callee’s image_hash to price a CALL) before deciding whether to take_key it. None for an absent key or a Missing(_) placeholder.

Source

pub fn set_key( &mut self, k: &[u8], target: Option<CapHashOrRef<O>>, ) -> Option<CapHashOrRef<O>>

Bind logical key k to target, or clear the binding if target is None. Returns the prior materialized target, if any — moved out, not cloned, so a CapHashOrRef::Owned(O) transfers with no deep copy (the zero-copy cnode move).

Source

pub fn take_key(&mut self, k: &[u8]) -> Option<CapHashOrRef<O>>

Take the binding at logical key k, leaving it empty. Returns the prior materialized target (or None), moved out — the zero-copy half of an Owned cnode-to-cnode (or frame-to-frame) move.

Source

pub fn set( &mut self, key: &Key, target: Option<CapHashOrRef<O>>, ) -> Result<Option<CapHashOrRef<O>>, CapError>

Bind key to target, or clear it if None. Returns the prior materialized target, if any. The radix map is unbounded, so this is infallible; the Result is retained for ABI compatibility with the pervasive ?-using call sites.

Source

pub fn take(&mut self, key: &Key) -> Result<Option<CapHashOrRef<O>>, CapError>

Take the binding at key, leaving it empty. Returns the prior materialized target (or None).

Source§

impl<O: Clone> CNodeCap<O>

Source

pub fn get_key(&self, k: &[u8]) -> Option<CapHashOrRef<O>>

Look up the cap bound to logical key k. Returns None for an absent key or a Missing(_) placeholder (callers needing to tell “absent” from “missing placeholder” apart inspect self.slots).

Source

pub fn get(&self, key: &Key) -> Option<CapHashOrRef<O>>

Look up the slot named by key. See CNodeCap::get_key for the placeholder semantics.

Trait Implementations§

Source§

impl<O> Archive for CNodeCap<O>
where CNodeSlots<O>: Archive,

Source§

type Archived = ArchivedCNodeCap<O>

The archived representation of this type. Read more
Source§

type Resolver = CNodeCapResolver<O>

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.
Source§

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output. Read more
§

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize. Read more
Source§

impl<O: Clone> Clone for CNodeCap<O>

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<O: Debug> Debug for CNodeCap<O>

Source§

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

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

impl<O> Default for CNodeCap<O>

Source§

fn default() -> Self

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

impl<__D: Fallible + ?Sized, O> Deserialize<CNodeCap<O>, __D> for Archived<CNodeCap<O>>
where CNodeSlots<O>: Archive, <CNodeSlots<O> as Archive>::Archived: Deserialize<CNodeSlots<O>, __D>,

Source§

fn deserialize( &self, deserializer: &mut __D, ) -> Result<CNodeCap<O>, <__D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<O> HashTreeRoot for CNodeCap<O>
where O: Clone, CapHashOrRef<O>: HashTreeRoot,

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<__S: Fallible + ?Sized, O> Serialize<__S> for CNodeCap<O>
where CNodeSlots<O>: Serialize<__S>,

Source§

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

Auto Trait Implementations§

§

impl<O> Freeze for CNodeCap<O>

§

impl<O> RefUnwindSafe for CNodeCap<O>
where O: RefUnwindSafe,

§

impl<O> Send for CNodeCap<O>
where O: Send,

§

impl<O> Sync for CNodeCap<O>
where O: Sync,

§

impl<O> Unpin for CNodeCap<O>
where O: Unpin,

§

impl<O> UnsafeUnpin for CNodeCap<O>

§

impl<O> UnwindSafe for CNodeCap<O>
where O: 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
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<T> ArchiveUnsized for T
where T: Archive,

§

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more
§

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.
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.

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

§

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.
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.