Struct Lib

pub struct Lib {
    pub isae: TinyOrdSet<IsaId>,
    pub code: SmallBlob,
    pub data: SmallBlob,
    pub libs: LibsSeg,
}

An AluVM library, which can be executed on a VM instance.

Fields

isae: TinyOrdSet<IsaId>

ISA extension segment.

code: SmallBlob

Code segment.

data: SmallBlob

Data segment.

libs: LibsSeg

Library segment keeping external library references.

Implementations

impl Lib

pub fn lib_id(&self) -> LibId

Compute a library identifier, which serves as a cryptographic commitment to the library contents.

pub fn isae_string(&self) -> String

String containing all ISA extensions used by the library, enumerated with spaces.

impl Lib

pub fn assemble<Isa>(code: &[Isa]) -> Result<Lib, AssemblerError>

where Isa: Instruction<LibId>,

Assembles a library from the provided instructions by encoding them into bytecode.

pub fn disassemble<Isa>(&self) -> Result<Vec<Isa>, CodeEofError>

where Isa: Instruction<LibId>,

Disassembles the library into a set of instructions.

pub fn print_disassemble<Isa>(&self, writer: impl Write) -> Result<(), Error>

where Isa: Instruction<LibId>,

Disassembles the library into a set of instructions and offsets and prints it to the writer.

impl Lib

pub fn exec<Instr>( &self, entrypoint: u16, skip_first: bool, core: &mut Core<LibId, Instr::Core>, context: &Instr::Context<'_>, ) -> Jump<LibId>

where Instr: Instruction<LibId> + Bytecode<LibId>,

Execute library code starting at the entrypoint.

Returns

Location for the external code jump, if any.

Trait Implementations

impl AsRef<Lib> for Lib

fn as_ref(&self) -> &Self

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

impl AsciiArmor for Lib

Available on crate feature armor only.

const PLATE_TITLE: &'static str = "ALUVM LIB"

type Err = LibArmorError

fn ascii_armored_headers(&self) -> Vec<ArmorHeader>

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

fn with_headers_data( _headers: Vec<ArmorHeader>, data: Vec<u8>, ) -> Result<Self, Self::Err>

fn to_ascii_armored_string(&self) -> String

fn display_ascii_armored(&self) -> DisplayAsciiArmored<'_, Self>

fn ascii_armored_digest(&self) -> Option<Array<u8, 32>>

fn from_ascii_armored_str(s: &str) -> Result<Self, Self::Err>

impl Clone for Lib

fn clone(&self) -> Lib

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitEncode for Lib

type CommitmentId = LibId

Type of the resulting commitment.

fn commit_encode(&self, engine: &mut CommitEngine)

Encodes the data for the commitment by writing them directly into a std::io::Write writer instance

impl Debug for Lib

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Lib

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Lib

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

Formats the value using the given formatter.

impl Hash for Lib

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Lib

fn cmp(&self, other: &Lib) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Lib

fn eq(&self, other: &Lib) -> 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 PartialOrd for Lib

fn partial_cmp(&self, other: &Lib) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Lib

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for Lib

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDeserialize for Lib

fn from_strict_serialized<const MAX: usize>( ast_data: Confined<Vec<u8>, 0, MAX>, ) -> Result<Self, DeserializeError>

fn strict_deserialize<const MAX: usize>( read: impl Read, ) -> Result<Self, DeserializeError>

fn strict_deserialize_from_file<const MAX: usize>( path: impl AsRef<Path>, ) -> Result<Self, DeserializeError>

impl StrictDumb for Lib

fn strict_dumb() -> Self

impl StrictEncode for Lib

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictSerialize for Lib

fn strict_serialized_len<const MAX: usize>(&self) -> Result<usize, Error>

fn to_strict_serialized<const MAX: usize>( &self, ) -> Result<Confined<Vec<u8>, 0, MAX>, SerializeError>

fn strict_serialize<const MAX: usize>( &self, write: impl Write, ) -> Result<(), Error>

fn strict_serialize_to_file<const MAX: usize>( &self, path: impl AsRef<Path>, ) -> Result<(), SerializeError>

impl StrictStruct for Lib

const ALL_FIELDS: &'static [&'static str]

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Lib

const STRICT_LIB_NAME: &'static str = LIB_NAME_ALUVM

fn strict_name() -> Option<TypeName>

impl Eq for Lib

impl StrictProduct for Lib

impl StructuralPartialEq for Lib