Struct pyoxidizerlib::starlark::env::PyOxidizerEnvironmentContext

pub struct PyOxidizerEnvironmentContext {
    pub verbose: bool,
    pub cwd: PathBuf,
    pub config_path: PathBuf,
    pub build_host_triple: String,
    pub build_target_triple: String,
    pub build_release: bool,
    pub build_opt_level: String,
    pub distribution_cache: Arc<DistributionCache>,
    // some fields omitted
}

Holds state for evaluating a Starlark config file.

Fields

verbose: bool

Whether executing in verbose mode.

cwd: PathBuf

Directory the environment should be evaluated from.

Typically used to resolve filenames.

config_path: PathBuf

Path to the configuration file.

build_host_triple: String

Host triple we are building from.

build_target_triple: String

Target triple we are building for.

build_release: bool

Whether we are building a debug or release binary.

build_opt_level: String

Optimization level when building binaries.

distribution_cache: Arc<DistributionCache>

Cache of ready-to-clone Python distribution objects.

This exists because constructing a new instance can take a few seconds in debug builds. And this adds up, especially in tests!

Implementations

impl PyOxidizerEnvironmentContext

pub fn new(
    env: &Environment,
    logger: Logger,
    verbose: bool,
    config_path: &Path,
    build_host_triple: &str,
    build_target_triple: &str,
    build_release: bool,
    build_opt_level: &str,
    distribution_cache: Option<Arc<DistributionCache>>,
    extra_vars: HashMap<String, Option<String>>
) -> Result<PyOxidizerEnvironmentContext>

pub fn env(&self) -> &Environment

pub fn logger(&self) -> &Logger

pub fn build_path(
    &self,
    type_values: &TypeValues
) -> Result<PathBuf, ValueError>

pub fn python_distributions_path(&self) -> Result<PathBuf, ValueError>

pub fn get_output_path(
    &self,
    type_values: &TypeValues,
    target: &str
) -> Result<PathBuf, ValueError>

Trait Implementations

impl Debug for PyOxidizerEnvironmentContext

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

Formats the value using the given formatter.

impl TypedValue for PyOxidizerEnvironmentContext

type Holder = Mutable<PyOxidizerEnvironmentContext>

Must be either MutableHolder<Self> or ImmutableHolder<Self>

const TYPE: &'static str

Return a string describing the type of self, as returned by the type() function.

fn values_for_descendant_check_and_freeze(
    &self
) -> Box<dyn Iterator<Item = Value>>

Return a list of values to be used in freeze or descendant check operations.

fn function_id(&self) -> Option<FunctionId>

Return function id to detect recursion.

fn to_str(&self) -> String

Return a string describing of self, as returned by the str() function.

fn to_str_impl(&self, buf: &mut String) -> Result<(), Error>

The implementation of to_str, more efficient for nested objects

fn to_repr(&self) -> String

Return a string representation of self, as returned by the repr() function.

fn to_repr_impl(&self, buf: &mut String) -> Result<(), Error>

The implementation of to_repr, more efficient for nested objects

fn to_bool(&self) -> bool

Convert self to a Boolean truth value, as returned by the bool() function.

fn to_int(&self) -> Result<i64, ValueError>

Convert self to a integer value, as returned by the int() function if the type is numeric (not for string).

fn get_hash(&self) -> Result<u64, ValueError>

Return a hash code for self, as returned by the hash() function, or OperationNotSupported if there is no hash for this value (e.g. list).

fn equals(&self, other: &Self) -> Result<bool, ValueError>

Compare self with other for equality.

fn compare(&self, _other: &Self) -> Result<Ordering, ValueError>

Compare self with other.

fn call(
    &self,
    _call_stack: &mut CallStack,
    _type_values: &TypeValues,
    _positional: Vec<Value, Global>,
    _named: LinkedHashMap<RcString, Value, RandomState>,
    _args: Option<Value>,
    _kwargs: Option<Value>
) -> Result<Value, ValueError>

Perform a call on the object, only meaningfull for function object.

fn at(&self, index: Value) -> Result<Value, ValueError>

Perform an array or dictionary indirection.

fn set_at(&mut self, index: Value, _new_value: Value) -> Result<(), ValueError>

Set the value at index with new_value.

fn slice(
    &self,
    _start: Option<Value>,
    _stop: Option<Value>,
    _stride: Option<Value>
) -> Result<Value, ValueError>

Extract a slice of the underlying object if the object is indexable. The result will be object between start and stop (both of them are added length() if negative and then clamped between 0 and length()). stride indicates the direction.

fn iter(&self) -> Result<&(dyn TypedIterable + 'static), ValueError>

Returns an iterable over the value of this container if this value hold an iterable container.

fn length(&self) -> Result<i64, ValueError>

Returns the length of the value, if this value is a sequence.

fn get_attr(&self, attribute: &str) -> Result<Value, ValueError>

Get an attribute for the current value as would be returned by dotted expression (i.e. a.attribute).

fn has_attr(&self, _attribute: &str) -> Result<bool, ValueError>

Return true if an attribute of name attribute exists for the current value.

fn set_attr(
    &mut self,
    attribute: &str,
    _new_value: Value
) -> Result<(), ValueError>

Set the attribute named attribute of the current value to new_value (e.g. a.attribute = new_value).

fn dir_attr(&self) -> Result<Vec<RcString, Global>, ValueError>

Return a vector of string listing all attribute of the current value, excluding native methods.

fn contains(&self, other: &Value) -> Result<bool, ValueError>

Tell wether other is in the current value, if it is a container.

fn plus(&self) -> Result<Self, ValueError>

Apply the + unary operator to the current value.

fn minus(&self) -> Result<Self, ValueError>

Apply the - unary operator to the current value.

fn add(&self, _other: &Self) -> Result<Self, ValueError>

Add other to the current value.

fn sub(&self, _other: &Self) -> Result<Self, ValueError>

Substract other from the current value.

fn mul(&self, other: Value) -> Result<Value, ValueError>

Multiply the current value with other.

fn percent(&self, other: Value) -> Result<Value, ValueError>

Apply the percent operator between the current value and other.

fn div(&self, other: Value) -> Result<Value, ValueError>

Divide the current value with other. division.

fn floor_div(&self, other: Value) -> Result<Value, ValueError>

Floor division between the current value and other.

fn pipe(&self, other: Value) -> Result<Value, ValueError>

Apply the operator pipe to the current value and other.