Struct Package 

pub struct Package {
    pub name: String,
    pub version: Option<Version>,
    pub description: Option<String>,
    pub mast: MastArtifact,
    pub manifest: PackageManifest,
    pub sections: Vec<Section>,
}

A package containing a Program/Library, and a manifest (exports and dependencies).

Fields

name: String

Name of the package

version: Option<Version>

An optional semantic version for the package

description: Option<String>

An optional description of the package

mast: MastArtifact

The MAST artifact (Program or Library) of the package

manifest: PackageManifest

The package manifest, containing the set of exported procedures and their signatures, if known.

sections: Vec<Section>

The set of custom sections included with the package, e.g. debug information, account metadata, etc.

Implementations

impl Package

pub fn digest(&self) -> Word

Returns the digest of the package’s MAST artifact

pub fn into_mast_artifact(self) -> MastArtifact

Returns the MastArtifact of the package

pub fn is_program(&self) -> bool

Checks if the package’s MAST artifact is a Program

pub fn is_library(&self) -> bool

Checks if the package’s MAST artifact is a Library

pub fn unwrap_program(&self) -> Arc<Program>

Unwraps the package’s MAST artifact as a Program or panics if it is a Library

pub fn unwrap_library(&self) -> Arc<Library>

Unwraps the package’s MAST artifact as a Library or panics if it is a Program

pub fn make_executable( &self, entrypoint: &QualifiedProcedureName, ) -> Result<Package, Report>

Creates a new package with Program from this Library package and the given entrypoint (should be a procedure in the library).

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Deserializable for Package

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

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

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

impl StructuralPartialEq for Package