Struct Environment

pub struct Environment {
    pub pyoxidizer_source: PyOxidizerSource,
    /* private fields */
}

Describes the PyOxidizer run-time environment.

Fields

pyoxidizer_source: PyOxidizerSource

Where a copy of PyOxidizer can be obtained from.

Implementations

impl Environment

pub fn new() -> Result<Self>

Obtain a new instance.

pub fn cache_dir(&self) -> &Path

Cache directory for PyOxidizer to use.

The cache is per-user but multi-process.

pub fn python_distributions_dir(&self) -> PathBuf

Directory to use for storing Python distributions.

pub fn rust_dir(&self) -> PathBuf

Directory to hold Rust toolchains.

pub fn unmanage_rust(&mut self) -> Result<()>

Do not use a managed Rust.

When called, [self.ensure_rust_toolchain()] will attempt to locate a Rust install on the system rather than manage it itself.

pub fn find_executable(&self, name: &str) -> Result<Option<PathBuf>>

Find an executable of the given name.

Resolves to Some(T) if an executable was found or None if not.

Errors if there were problems searching for executables.

pub fn ensure_rust_toolchain( &self, target_triple: Option<&str>, ) -> Result<RustEnvironment>

Ensure a Rust toolchain suitable for building is available.

pub fn resolve_apple_sdk(&self, sdk_info: &AppleSdkInfo) -> Result<ParsedSdk>

Attempt to resolve an appropriate Apple SDK to use given settings.

pub fn temporary_directory(&self, prefix: &str) -> Result<TempDir>

Create a new temporary directory.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.