Struct FileValue

pub struct FileValue { /* private fields */ }

Starlark value wrapper for File.

Implementations

impl FileValue

pub fn new(file: File) -> Self

pub fn inner( &self, label: &str, ) -> Result<MutexGuard<'_, FileWrapper>, ValueError>

Trait Implementations

impl Clone for FileValue

fn clone(&self) -> FileValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileValue

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

Formats the value using the given formatter.

impl ResourceCollectionContext for FileValue

fn add_collection_context( &self, ) -> Result<Option<PythonResourceAddCollectionContext>, ValueError>

Obtain the PythonResourceAddCollectionContext associated with this instance, if available.

fn replace_add_collection_context( &mut self, context: PythonResourceAddCollectionContext, ) -> Result<Option<PythonResourceAddCollectionContext>, ValueError>

Set the PythonResourceAddCollectionContext value on this instance.

fn as_python_resource(&self) -> Result<PythonResource<'_>, ValueError>

Cast this instance to a PythonResource.

fn add_collection_context_attrs(&self) -> Vec<&'static str>

Obtains the Starlark object attributes that are defined by the add collection context.

fn get_attr_add_collection_context(&self, attribute: &str) -> ValueResult

Obtain the attribute value for an add collection context.

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

impl TypedValue for FileValue

const TYPE: &'static str = "File"

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

type Holder = Mutable<FileValue>

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

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 to_str(&self) -> String

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

fn to_repr(&self) -> String

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

fn get_attr(&self, attribute: &str) -> ValueResult

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, value: Value) -> Result<(), ValueError>

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

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

Return function id to detect recursion.

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

The implementation of to_str, more efficient for nested objects

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>, _named: LinkedHashMap<RcString, Value>, _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 dir_attr(&self) -> Result<Vec<RcString>, 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.