Struct KernelLibrary 

pub struct KernelLibrary { /* private fields */ }

Represents a library containing a Miden VM kernel.

This differs from the regular Library as follows:

• All exported procedures must be exported directly from the kernel namespace (i.e., $kernel).
• There must be at least one exported procedure.
• The number of exported procedures cannot exceed Kernel::MAX_NUM_PROCEDURES (i.e., 256).

Implementations

impl KernelLibrary

pub fn kernel(&self) -> &Kernel

Returns the Kernel for this kernel library.

pub fn mast_forest(&self) -> &Arc<MastForest>

Returns a reference to the inner MastForest.

pub fn into_parts(self) -> (Kernel, ModuleInfo, Arc<MastForest>)

Destructures this kernel library into individual parts.

pub fn read_from_unchecked<R>( source: &mut R, ) -> Result<KernelLibrary, DeserializationError>

where R: ByteReader,

Reads a kernel library from source without validating the embedded MAST forest.

This is only correct when serialization and deserialization happen within the same trust domain. A typical use case is reloading bytes that were already validated before being persisted to local storage controlled by the same trusted system.

Do not use this for inbound artifact processing across a trust boundary, including bytes received over the network or from another party. Authenticating the outer byte stream does not prove that embedded MAST node digests are semantically valid.

pub fn read_from_bytes_unchecked( bytes: &[u8], ) -> Result<KernelLibrary, DeserializationError>

Reads a kernel library from bytes without validating the embedded MAST forest.

See KernelLibrary::read_from_unchecked.

impl KernelLibrary

pub fn write_to_file(&self, path: impl AsRef<Path>) -> Result<(), Error>

Write the library to a target file

Trait Implementations

impl AsRef<Library> for KernelLibrary

fn as_ref(&self) -> &Library

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KernelLibrary

fn clone(&self) -> KernelLibrary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KernelLibrary

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

Formats the value using the given formatter.

impl Deserializable for KernelLibrary

NOTE: Serialization of libraries is likely to be deprecated in a future release

fn read_from<R>(source: &mut R) -> Result<KernelLibrary, 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 KernelLibrary

fn deserialize<__D>( __deserializer: __D, ) -> Result<KernelLibrary, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KernelLibrary

impl PartialEq for KernelLibrary

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serializable for KernelLibrary

NOTE: Serialization of libraries is likely to be deprecated in a future release

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 KernelLibrary

Available on crate feature serde only.

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 KernelLibrary

impl TryFrom<Arc<Library>> for KernelLibrary

type Error = LibraryError

The type returned in the event of a conversion error.

fn try_from( library: Arc<Library>, ) -> Result<KernelLibrary, <KernelLibrary as TryFrom<Arc<Library>>>::Error>

Performs the conversion.