Skip to main content

CapHashOrRef

Enum CapHashOrRef 

Source
pub enum CapHashOrRef<O = Box<Cap>> {
    Hash(CapHash),
    Owned(O),
}
Expand description

Slot/field reference: a content-addressed blob in cache.blobs (Hash), or a single-owner cap held inline by the running kernel frame (Owned).

Owned(Box<Cap>) is the zero-copy ownership form: a cap the kernel frame owns outright and moves between cnode slots (and between frames, at HALT) with no cache round-trip and no data copy — the move is a Box pointer swap. It is runtime-only: it never crosses the wire and is never hashed. The recompiler mints it on derive_spawn and moves it through host_call; it never settles one (the host-side settle arm folds it into a blob for the deferred persist path).

SSZ note: CapHashOrRef’s HashTreeRoot impl is hand-rolled, not derived. The pass-through semantics — Hash(h) hashes to h — let a freshly-published cap substitute for a content reference without changing the hash of any cap that holds it. The Owned arm panics: callers must settle a cap graph before hashing it. Encode mirrors HashTreeRoot (panic on the runtime-only arm); Decode only ever produces Hash (the wire carries selector 0).

Generic over the owned payload O (default Box<Cap>). The wire form (the cnode inside a serialised Cap) is always CapHashOrRef<Box<Cap>>, so Cap and its hash are unaffected. An engine may instantiate a running frame’s cnode with a richer, deliberately non-wire payload (e.g. Box<CachedCap>); the serialisation impls below are gated on O: rkyv::Archive, so such a payload makes the cnode non-hashable and non-serialisable at compile time (a strictly stronger guarantee than the runtime Owned panic).

Not Copy: the Owned(O) arm carries the (usually heap-allocated) payload, so the enum is Clone-only (when O: Clone).

PartialEq/Eq/Hash are hand-written: a Box<Cap> payload blocks the derive (Cap is not Eq/Hash). The Hash arm compares/hashes its 32-byte digest by value; the Owned arm uses pointer identity of the inline payload (sound — Owned is single-owner runtime state, never content-compared — and O-agnostic, so it needs no bound).

Variants§

§

Hash(CapHash)

§

Owned(O)

Trait Implementations§

Source§

impl<O: WireOwned> Archive for CapHashOrRef<O>

Source§

type Archived = <[u8; 32] as Archive>::Archived

The archived representation of this type. Read more
Source§

type Resolver = <[u8; 32] as Archive>::Resolver

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 CapHashOrRef<O>

Source§

fn clone(&self) -> CapHashOrRef<O>

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 CapHashOrRef<O>

Source§

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

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

impl<O: WireOwned> Decode for CapHashOrRef<O>

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<O, D> Deserialize<CapHashOrRef<O>, D> for [u8; 32]
where D: Fallible + ?Sized,

Source§

fn deserialize( &self, _deserializer: &mut D, ) -> Result<CapHashOrRef<O>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<O: WireOwned> Encode for CapHashOrRef<O>

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.
§

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).
§

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

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

impl<O> Hash for CapHashOrRef<O>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<O: WireOwned> HashTreeRoot for CapHashOrRef<O>

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<O> PartialEq for CapHashOrRef<O>

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<O, S> Serialize<S> for CapHashOrRef<O>
where O: WireOwned, S: Fallible + ?Sized, <S as Fallible>::Error: Source, CapHash: Serialize<S>,

Source§

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

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

impl<O> Eq for CapHashOrRef<O>

Auto Trait Implementations§

§

impl<O> Freeze for CapHashOrRef<O>
where O: Freeze,

§

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

§

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

§

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

§

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

§

impl<O> UnsafeUnpin for CapHashOrRef<O>
where O: UnsafeUnpin,

§

impl<O> UnwindSafe for CapHashOrRef<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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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.