Struct Library 

pub struct Library { /* private fields */ }

Represents a library where all modules were compiled into a MastForest.

A library exports a set of one or more procedures. Currently, all exported procedures belong to the same top-level namespace.

Implementations

impl Library

Constructors

pub fn new( mast_forest: Arc<MastForest>, exports: BTreeMap<Arc<Path>, LibraryExport>, ) -> Result<Library, LibraryError>

Constructs a new Library from the provided MAST forest and a set of exports.

Errors

Returns an error if the set of exports is empty. Returns an error if any of the specified exports do not have a corresponding procedure root in the provided MAST forest.

pub fn with_advice_map(self, advice_map: AdviceMap) -> Library

Produces a new library with the existing MastForest and where all key/values in the provided advice map are added to the internal advice map.

impl Library

Public accessors

pub fn digest(&self) -> &Word

Returns the [Word] representing the content hash of this library

pub fn exports(&self) -> impl Iterator<Item = &LibraryExport>

Returns the fully qualified name and metadata of all procedures exported by the library.

pub fn num_exports(&self) -> usize

Returns the number of exports in this library.

pub fn get_export_node_id(&self, path: impl AsRef<Path>) -> MastNodeId

Returns a MAST node ID associated with the specified exported procedure.

Panics

Panics if the specified procedure is not exported from this library.

pub fn is_reexport(&self, path: impl AsRef<Path>) -> bool

Returns true if the specified exported procedure is re-exported from a dependency.

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

Returns a reference to the inner MastForest.

pub fn get_procedure_root_by_path(&self, path: impl AsRef<Path>) -> Option<Word>

Returns the digest of the procedure with the specified name, or None if it was not found in the library or its library path is malformed.

impl Library

Conversions

pub fn module_infos(&self) -> impl Iterator<Item = ModuleInfo>

Returns an iterator over the module infos of the library.

impl Library

pub const LIBRARY_EXTENSION: &'static str = "masl"

File extension for the Assembly Library.

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

Write the library to a target file

NOTE: It is up to the caller to use the correct file extension, but there is no specific requirement that the extension be set, or the same as Self::LIBRARY_EXTENSION.

pub fn deserialize_from_file( path: impl AsRef<Path>, ) -> Result<Library, DeserializationError>

Trait Implementations

impl Arbitrary for Library

Available on crate feature arbitrary only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Library>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( _args: <Library as Arbitrary>::Parameters, ) -> <Library as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl AsRef<Library> for KernelLibrary

fn as_ref(&self) -> &Library

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

impl AsRef<Library> for Library

fn as_ref(&self) -> &Library

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

impl Clone for Library

fn clone(&self) -> Library

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Library

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

Formats the value using the given formatter.

impl Deserializable for Library

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

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

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Library

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

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 Library

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

impl StructuralPartialEq for Library