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., #sys).
• 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.

impl KernelLibrary

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

Write the library to a target file

pub fn from_dir( sys_module_path: impl AsRef<Path>, lib_dir: Option<impl AsRef<Path>>, assembler: Assembler, ) -> Result<KernelLibrary, Report>

Create a KernelLibrary from a standard Miden Assembly kernel project layout.

The kernel library will export procedures defined by the module at sys_module_path. If the optional lib_dir is provided, all modules under this directory will be available from the kernel module under the kernel namespace. For example, if lib_dir is set to “~/masm/lib”, the files will be accessible in the kernel module as follows:

• ~/masm/lib/foo.masm -> Can be imported as “kernel::foo”
• ~/masm/lib/bar/baz.masm -> Can be imported as “kernel::bar::baz”

Note: this is a temporary structure which will likely change once https://github.com/0xPolygonMiden/miden-vm/issues/1436 is implemented.

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 copy 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

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 read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

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

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

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 TryFrom<Library> for KernelLibrary

type Error = LibraryError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for KernelLibrary

impl StructuralPartialEq for KernelLibrary