Struct PackageManifest 

pub struct PackageManifest { /* private fields */ }

The manifest of a package, containing the set of package dependencies (libraries or packages) and exported items (procedures, constants, types), if known.

Implementations

impl PackageManifest

pub fn new( exports: impl IntoIterator<Item = PackageExport>, ) -> Result<PackageManifest, ManifestValidationError>

Construct a new PackageManifest by providing the set of exports for the corresponding package.

pub fn from_library(library: &Library) -> PackageManifest

Construct a new PackageManifest by deriving export information from the given Library.

pub fn with_dependencies( self, dependencies: impl IntoIterator<Item = Dependency>, ) -> Result<PackageManifest, ManifestValidationError>

Extend this manifest with the provided dependencies

pub fn add_dependency( &mut self, dependency: Dependency, ) -> Result<(), ManifestValidationError>

Add a dependency to the manifest

pub fn num_dependencies(&self) -> usize

Get the number of dependencies of this package

pub fn dependencies(&self) -> impl Iterator<Item = &Dependency>

Get an iterator over the dependencies of this package

pub fn num_exports(&self) -> usize

Get the number of items exported from this package

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

Get an iterator over the exports in this package

pub fn get_export(&self, name: impl AsRef<Path>) -> Option<&PackageExport>

Get information about an export by it’s qualified name

pub fn get_procedures_by_digest( &self, digest: &Word, ) -> impl Iterator<Item = &ProcedureExport>

Get information about all exported procedures of this package with the given MAST root digest

Trait Implementations

impl Clone for PackageManifest

fn clone(&self) -> PackageManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageManifest

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

Formats the value using the given formatter.

impl Default for PackageManifest

fn default() -> PackageManifest

Returns the “default value” for a type.

impl Deserializable for PackageManifest

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

Available on crate feature serde only.

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PackageManifest

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

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 PackageManifest

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 Eq for PackageManifest

impl StructuralPartialEq for PackageManifest