Struct pyoxidizerlib::pyrepackager::state::BuildContext

pub struct BuildContext {
    pub project_path: PathBuf,
    pub config_path: PathBuf,
    pub config_parent_path: PathBuf,
    pub config: Config,
    pub cargo_config: Manifest,
    pub verbose: bool,
    pub build_path: PathBuf,
    pub app_name: String,
    pub app_path: PathBuf,
    pub app_exe_path: PathBuf,
    pub distributions_path: PathBuf,
    pub host_triple: String,
    pub target_triple: String,
    pub release: bool,
    pub target_base_path: PathBuf,
    pub target_triple_base_path: PathBuf,
    pub python_distribution_path: PathBuf,
    pub app_target_path: PathBuf,
    pub app_exe_target_path: PathBuf,
    pub pyoxidizer_artifacts_path: PathBuf,
    pub packaging_state: Option<PackagingState>,
}

Represents environment for a build.

Fields

project_path: PathBuf

Path to Rust project.

config_path: PathBuf

Path to PyOxidizer configuration file.

config_parent_path: PathBuf

Path to directory containing PyOxidizer configuration file.

config: Config

Parsed PyOxidizer configuration file.

cargo_config: Manifest

Parsed Cargo.toml for Rust project.

verbose: bool

Whether to operate in verbose mode.

build_path: PathBuf

Path to main build directory where all state is stored.

app_name: String

Name of application/binary being built.

app_path: PathBuf

Path containing build/packaged application and all supporting files.

app_exe_path: PathBuf

Path to application executable in its installed/packaged directory.

distributions_path: PathBuf

Path where distribution files should be written.

host_triple: String

Rust target triple for build host.

target_triple: String

Rust target triple for build target.

release: bool

Whether compiling a release build.

target_base_path: PathBuf

Main output path for Rust build artifacts.

Should be passed as --target to cargo build.

target_triple_base_path: PathBuf

Rust build artifact output path for this target.

python_distribution_path: PathBuf

Path to extracted Python distribution.

app_target_path: PathBuf

Rust build artifact output path for the application crate.

app_exe_target_path: PathBuf

Application executable in its Rust target directory.

pyoxidizer_artifacts_path: PathBuf

Path where PyOxidizer should write its build artifacts.

packaging_state: Option<PackagingState>

State used for packaging.

Implementations

impl BuildContext

pub fn new(
    project_path: &Path,
    config_path: &Path,
    host: Option<&str>,
    target: &str,
    release: bool,
    force_artifacts_path: Option<&Path>,
    verbose: bool
) -> Result<Self, String>

pub fn get_packaging_state(&mut self) -> Result<PackagingState, String>

Obtain the PackagingState instance for this configuration.

This basically reads the packaging_state.cbor file from the artifacts directory.