Struct Package

pub struct Package {
    pub base_directory: PathBuf,
    pub programs: Vec<Program>,
    pub manifest: Manifest,
    pub env: Env,
}

A Leo package.

Fields

base_directory: PathBuf

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

programs: Vec<Program>

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

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

manifest: Manifest

The manifest file of this package.

env: Env

The .env file of this package.

Implementations

impl Package

pub fn outputs_directory(&self) -> PathBuf

pub fn imports_directory(&self) -> PathBuf

pub fn build_directory(&self) -> PathBuf

pub fn source_directory(&self) -> PathBuf

pub fn tests_directory(&self) -> PathBuf

pub fn initialize<P: AsRef<Path>>( package_name: &str, path: P, network: NetworkName, endpoint: &str, ) -> Result<PathBuf>

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

fn initialize_impl( package_name: &str, path: &Path, network: NetworkName, endpoint: &str, ) -> Result<PathBuf>

pub fn from_directory_no_graph<P: AsRef<Path>, Q: AsRef<Path>>( path: P, home_path: Q, ) -> 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 or env file.

pub fn from_directory<P: AsRef<Path>, Q: AsRef<Path>>( path: P, home_path: Q, no_cache: bool, ) -> 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, ) -> 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>

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

fn files_with_extension( path: &Path, extension: &'static str, ) -> impl Iterator<Item = PathBuf>

fn from_directory_impl( path: &Path, home_path: &Path, build_graph: bool, with_tests: bool, no_cache: bool, ) -> Result<Self>

fn graph_build( home_path: &Path, network: NetworkName, endpoint: &str, main_program: &Dependency, new: Dependency, map: &mut IndexMap<Symbol, (Dependency, Program)>, graph: &mut DiGraph<Symbol>, no_cache: bool, ) -> Result<()>

pub fn get_programs_and_manifests<P: AsRef<Path>>( &self, home_path: P, ) -> Result<Vec<(String, String, Option<Manifest>)>>

Get the program ID, program, and optional manifest for all programs in the package. This method assumes that the package has already been built (leo build has been run).

fn get_programs_and_manifests_impl( &self, home_path: &Path, ) -> Result<Vec<(String, String, Option<Manifest>)>>

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy 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.