Struct starlark_dialect_build_targets::EnvironmentContext

pub struct EnvironmentContext {
    pub default_build_script_target: Option<String>,
    pub build_script_mode: bool,
    /* private fields */
}

Holds execution context for a Starlark environment.

Fields

default_build_script_target: Option<String>

Name of default target to resolve in build script mode.

build_script_mode: bool

Whether we are operating in Rust build script mode.

This will change the default target to resolve.

Implementations

impl EnvironmentContext

pub fn new(cwd: PathBuf) -> Self

pub fn cwd(&self) -> &Path

Obtain the current working directory for this context.

pub fn build_path(&self) -> &Path

Directory to use for the build path.

pub fn set_build_path(&mut self, path: &Path) -> Result<()>

Update the directory to use for the build path.

pub fn resolve_path(&self, path: impl AsRef<Path>) -> PathBuf

Resolve an absolute filesystem path from a path input.

If the incoming path is absolute, it is returned. Otherwise relative paths are joined with the current build path.

pub fn set_target_build_path_prefix<P: AsRef<Path>>(&mut self, prefix: Option<P>)

Set the path prefix to use for per-target build paths.

If defined, target build paths are of the form <build_path>/<prefix>/<target>. Otherwise they are <build_path>/<target>.

pub fn target_build_path(&self, target: &str) -> PathBuf

Obtain the directory to use to build a named target.

pub fn targets(&self) -> &BTreeMap<String, Target>

Obtain all registered targets.

pub fn default_target(&self) -> Option<&str>

Obtain the default target to resolve.

pub fn get_target(&self, target: &str) -> Option<&Target>

Obtain a named target.

pub fn get_target_mut(&mut self, target: &str) -> Option<&mut Target>

Obtain a mutable named target.

pub fn set_resolve_targets(&mut self, targets: Vec<String>)

Set the list of targets to resolve.

pub fn targets_order(&self) -> &Vec<String>

Obtain the order that targets were registered in.

pub fn register_target(
    &mut self,
    target: String,
    callable: Value,
    depends: Vec<String>,
    default: bool,
    default_build_script: bool
)

Register a named target.

pub fn targets_to_resolve(&self) -> Vec<String>

Determine what targets should be resolved.

This isn’t the full list of targets that will be resolved, only the main targets that we will instruct the resolver to resolve.

Trait Implementations

impl Debug for EnvironmentContext

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

Formats the value using the given formatter.

impl TypedValue for EnvironmentContext

type Holder = Mutable<EnvironmentContext>

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

const TYPE: &'static str = "EnvironmentContext"

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.