Struct KernelDescriptor 

pub struct KernelDescriptor(/* private fields */);

A list of exported kernel procedure hashes defining a VM kernel.

The internally-stored list always has a consistent order, regardless of the order of procedure list used to instantiate a descriptor.

Implementations

impl KernelDescriptor

pub const MAX_NUM_PROCEDURES: usize

The maximum number of procedures which can be exported from a KernelDescriptor.

pub fn new(proc_hashes: &[Word]) -> Result<KernelDescriptor, KernelError>

Returns a new KernelDescriptor instantiated with the specified procedure hashes.

Hashes are canonicalized into a consistent internal order.

Errors

Returns an error if:

• proc_hashes contains duplicates.
• proc_hashes.len() exceeds MAX_NUM_PROCEDURES.

pub fn from_hashes(hashes: Vec<Word>) -> Result<KernelDescriptor, KernelError>

Returns a new KernelDescriptor from owned procedure hashes.

Hashes are canonicalized into a consistent internal order.

Errors

Returns an error if:

• hashes contains duplicates.
• hashes.len() exceeds MAX_NUM_PROCEDURES.

pub fn is_empty(&self) -> bool

Returns true if this kernel does not contain any procedures.

pub fn contains_proc(&self, proc_hash: Word) -> bool

Returns true if a procedure with the specified hash belongs to this kernel.

Note: the kernel is constructed from exported kernel procedures only.

pub fn proc_hashes(&self) -> &[Word]

Returns a list of procedure hashes contained in this kernel.

pub fn commitment(&self) -> Word

Returns the canonical commitment to this kernel: the domain-tagged sequential hash of the flattened procedure digests, hash_elements_in_domain(flatten(procs), KERNEL_DOMAIN_TAG).

This is the fixed-size identifier observed by the recursive verifier in place of the raw digest list. The encoding is normative:

• element order is this descriptor’s canonical procedure order (fixed at construction);
• the Sponge2 padding rule (https://eprint.iacr.org/2024/911) places len % rate in the first capacity element, preventing ambiguity between a partial block and its zero-padded form.

Trait Implementations

impl Clone for KernelDescriptor

fn clone(&self) -> KernelDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KernelDescriptor

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

Formats the value using the given formatter.

impl Default for KernelDescriptor

fn default() -> KernelDescriptor

Returns the “default value” for a type.

impl Deserializable for KernelDescriptor

fn read_from<R>( source: &mut R, ) -> Result<KernelDescriptor, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de> Deserialize<'de> for KernelDescriptor

Available on crate feature serde only.

fn deserialize<D>( deserializer: D, ) -> Result<KernelDescriptor, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KernelDescriptor

impl PartialEq for KernelDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serializable for KernelDescriptor

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for KernelDescriptor

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KernelDescriptor