Struct Context

pub struct Context {
    pub path: Option<PathBuf>,
    pub home: Option<PathBuf>,
    pub recursive: bool,
}

Project context, manifest, current directory etc All the info that is relevant in most of the commands

Fields

path: Option<PathBuf>

Path at which the command is called, None when default

home: Option<PathBuf>

Path to use for the Aleo registry, None when default

recursive: bool

Recursive flag.

Implementations

impl Context

pub fn new( path: Option<PathBuf>, home: Option<PathBuf>, recursive: bool, ) -> Result<Context>

pub fn parent_dir(&self) -> Result<PathBuf>

Returns the path of the parent directory to the Leo package.

pub fn dir(&self) -> Result<PathBuf>

Returns the path to the Leo package.

pub fn home(&self) -> Result<PathBuf>

Returns the path to the Aleo registry directory.

pub fn open_manifest<N: Network>(&self) -> Result<Manifest<N>>

Returns the package name as a String. Opens the manifest file program.json and creates the build directory if it doesn’t exist.

pub fn local_dependency_paths(&self) -> Result<Vec<(String, PathBuf)>>

Returns a post ordering of the local dependencies. Found by reading the lock file leo.lock.

pub fn dotenv_private_key<N: Network>(&self) -> Result<PrivateKey<N>>

Returns the private key from the .env file specified in the directory.

pub fn dotenv_endpoint(&self) -> Result<String>

Returns the endpoint from the .env file specified in the directory.

pub fn dotenv_network(&self) -> Result<String>

Returns the network from the .env file specified in the directory.

pub fn get_endpoint(&self, endpoint: &Option<String>) -> Result<String>

Returns the endpoint to interact with the network. If the --endpoint options is not provided, it will default to the one in the .env file.

pub fn get_network(&self, network: &Option<String>) -> Result<String>

Returns the network name. If the --network options is not provided, it will default to the one in the .env file.

pub fn get_private_key<N: Network>( &self, private_key: &Option<String>, ) -> Result<PrivateKey<N>>

Returns the private key. If the --private-key options is not provided, it will default to the one in the .env file.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.