Struct Package 

pub struct Package {
    pub base_directory: PathBuf,
    pub compilation_units: Vec<CompilationUnit>,
    pub manifest: Manifest,
    pub dep_graph: DiGraph<Symbol>,
}

A Leo package.

Fields

base_directory: PathBuf

The directory on the filesystem where the package is located, canonicalized.

compilation_units: Vec<CompilationUnit>

A topologically sorted list of all compilation units in this package, whether dependencies or the main program.

Any unit’s dependent unit will appear before it, so that compiling them in order should give access to all stubs necessary to compile each compilation unit.

manifest: Manifest

The manifest file of this package.

dep_graph: DiGraph<Symbol>

The dependency graph of the package.

Implementations

impl Package

pub fn build_directory(&self) -> PathBuf

The root of the build directory.

This is the single place that knows where build artifacts are rooted; every per-unit path below is composed from it.

pub fn primary_unit(&self) -> Option<&CompilationUnit>

The package’s own compilation unit, identified via the manifest. Robust under --build-tests (unlike compilation_units.last()).

pub fn unit_build_directory(&self, name: &str) -> PathBuf

The build/<name>/ directory for a single compilation unit - a program, library, or test - whether it is this package’s own unit, a local dependency, or a fetched network import.

pub fn unit_bytecode_path(&self, name: &str) -> PathBuf

Path to a unit’s compiled Aleo bytecode: build/<name>/<name>.aleo. Only programs and tests produce bytecode; libraries do not.

pub fn unit_abi_path(&self, name: &str) -> PathBuf

Path to a unit’s Leo ABI: build/<name>/abi.json.

pub fn unit_interfaces_directory(&self, name: &str) -> PathBuf

Path to a unit’s interface ABI directory: build/<name>/interfaces/. Both programs and libraries can declare interfaces.

pub fn unit_snapshots_directory(&self, name: &str) -> PathBuf

Path to a unit’s AST-snapshot directory: build/<name>/snapshots/. Populated only when a snapshot CLI flag is set; created lazily by the compiler on the first write, so absent on builds that don’t request snapshots.

pub fn source_directory(&self) -> PathBuf

pub fn tests_directory(&self) -> PathBuf

pub fn initialize<P: AsRef<Path>>( package_name: &str, path: P, is_library: bool, ) -> Result<PathBuf>

Create a Leo package by the name package_name in a subdirectory of path.

pub fn from_directory_no_graph<P: AsRef<Path>, Q: AsRef<Path>>( path: P, home_path: Q, network: Option<NetworkName>, endpoint: Option<&str>, network_retries: u32, ) -> Result<Self>

Examine the Leo package at path to create a Package, but don’t find dependencies.

This may be useful if you just need other information like the manifest file.

pub fn from_directory<P: AsRef<Path>, Q: AsRef<Path>>( path: P, home_path: Q, no_cache: bool, no_local: bool, network: Option<NetworkName>, endpoint: Option<&str>, network_retries: u32, ) -> Result<Self>

Examine the Leo package at path to create a Package, including all its dependencies, obtaining dependencies from the file system or network and topologically sorting them.

pub fn from_directory_with_tests<P: AsRef<Path>, Q: AsRef<Path>>( path: P, home_path: Q, no_cache: bool, no_local: bool, network: Option<NetworkName>, endpoint: Option<&str>, network_retries: u32, ) -> Result<Self>

Examine the Leo package at path to create a Package, including all its dependencies and its tests, obtaining dependencies from the file system or network and topologically sorting them.

pub fn test_files(&self) -> impl Iterator<Item = PathBuf>

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

Formats the value using the given formatter.