Struct starlark::values::string::StarlarkStr

#[repr(C)]
pub struct StarlarkStr { /* fields omitted */ }

A pointer to this type represents a Starlark string. Use of this type is discouraged and not considered stable.

Implementations

impl StarlarkStr

pub fn unpack(&self) -> &str

pub fn as_str_hashed(&self) -> BorrowHashed<'_, str>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl<'a> AnyLifetime<'a> for StarlarkStr

fn static_type_id() -> TypeId

Must return the TypeId of Self but where the lifetimes are changed to 'static. Must be consistent with static_type_of.

fn static_type_of(&self) -> TypeId

Must return the TypeId of Self but where the lifetimes are changed to 'static. Must be consistent with static_type_id. Must not consult the self parameter in any way.

impl Debug for StarlarkStr

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

Formats the value using the given formatter.

impl<'v> StarlarkValue<'v> for StarlarkStr

fn get_type(&self) -> &'static str

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

fn get_type_value(&self) -> FrozenValue

Like get_type, but returns a reusable FrozenValue pointer to it. This function deliberately doesn’t take a heap, as it would not be performant to allocate a new value each time.

fn get_methods(&self) -> Option<&'static Globals>

Get the members associated with this type, accessible via this_type.x. These members will have dir/getattr/hasattr properly implemented, so it is the preferred way to go if possible. See GlobalsStatic for an example of how to define this method.

fn collect_repr(&self, buffer: &mut String)

Return a string representation of self, as returned by the repr() function. Defaults to the Debug instance, but most types should override this method. In many cases the repr() representation will also be a Starlark expression for creating the value.

fn to_json(&self) -> Result<String>

Convert the type to a JSON string.

fn to_bool(&self) -> bool

Convert self to a boolean, as returned by the bool() function. The default implementation returns true.

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

Return a hash code for self to be used when self is placed as a key in a Dict. Return an Err if there is no hash for this value (e.g. list). Must be stable between frozen and non-frozen values.

fn equals(&self, other: Value<'_>) -> Result<bool>

Compare self with other for equality. Should only return an error on excessive recursion.

fn compare(&self, other: Value<'_>) -> Result<Ordering>

Compare self with other. This method returns a result of type Ordering, or an Err if the two types differ.

fn at(&self, index: Value<'_>, heap: &'v Heap) -> Result<Value<'v>>

Return the result of a[index] if a is indexable.

fn length(&self) -> Result<i32>

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

fn is_in(&self, other: Value<'_>) -> Result<bool>

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

fn slice(
    &self,
    start: Option<Value<'_>>,
    stop: Option<Value<'_>>,
    stride: Option<Value<'_>>,
    heap: &'v Heap
) -> Result<Value<'v>>

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 add(&self, other: Value<'v>, heap: &'v Heap) -> Result<Value<'v>>

Add other to the current value. Pass both self and the Value form of self as original.

fn mul(&self, other: Value<'v>, heap: &'v Heap) -> Result<Value<'v>>

Multiply the current value with other.

fn percent(&self, other: Value<'v>, heap: &'v Heap) -> Result<Value<'v>>

Apply the percent operator between the current value and other. Usually used on strings, as per the Starlark spec.

fn matches_type(&self, ty: &str) -> bool

Is this value a match for a named type. Usually returns true for values matching get_type, but might also work for subtypes it implements.

fn documentation(&self) -> Option<DocItem>

Return structured documentation for self, if available.

fn to_int(&self) -> Result<i32>

Convert self to a integer value, as returned by the int() function if the type is numeric (not for string). Works for int and bool (0 = false, 1 = true).

fn invoke(
    &self,
    _me: Value<'v>,
    _location: Option<Span>,
    _args: Arguments<'v, '_>,
    _eval: &mut Evaluator<'v, '_>
) -> Result<Value<'v>>

Directly invoke a function. The number of named and names arguments are guaranteed to be equal. A direct implementation is responsible for calling Evaluator::with_call_stack to ensure the call stack is properly updated.

fn iterate<'a>(
    &'a self,
    _heap: &'v Heap
) -> Result<Box<dyn Iterator<Item = Value<'v>> + 'a>> where
    'v: 'a, 

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

fn with_iterator(
    &self,
    heap: &'v Heap,
    f: &mut dyn FnMut(&mut dyn Iterator<Item = Value<'v>>) -> Result<()>
) -> Result<()>

Call a function with the same iterator as would be returned from iterate. The one advantage is that the iterator does not need to be allocated in a Box. If you implement this function you must also implement iterate, but the reverse is not true (this function has a sensible default).

fn get_attr(&self, _attribute: &str, _heap: &'v Heap) -> Option<Value<'v>>

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

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

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

fn dir_attr(&self) -> Vec<String>

Return a vector of string listing all attribute of the current value.

fn plus(&self, _heap: &'v Heap) -> Result<Value<'v>>

Apply the + unary operator to the current value.

fn minus(&self, _heap: &'v Heap) -> Result<Value<'v>>

Apply the - unary operator to the current value.

fn radd(&self, _lhs: Value<'v>, _heap: &'v Heap) -> Option<Result<Value<'v>>>

Add with the arguments the other way around. Should return None to fall through to normal add.

fn sub(&self, other: Value<'v>, _heap: &'v Heap) -> Result<Value<'v>>

Substract other from the current value.

fn floor_div(&self, other: Value<'v>, _heap: &'v Heap) -> Result<Value<'v>>

Floor division between the current value and other.

fn bit_and(&self, other: Value<'v>) -> Result<Value<'v>>

Bitwise & operator.

fn bit_or(&self, other: Value<'v>) -> Result<Value<'v>>

Bitwise | operator.

fn bit_xor(&self, other: Value<'v>) -> Result<Value<'v>>

Bitwise ^ operator.

fn left_shift(&self, other: Value<'v>) -> Result<Value<'v>>

Bitwise << operator.

fn right_shift(&self, other: Value<'v>) -> Result<Value<'v>>

Bitwise >> operator.

fn export_as(&self, _variable_name: &str, _eval: &mut Evaluator<'v, '_>)

Called when exporting a value under a specific name,

fn set_at(&self, _index: Value<'v>, _new_value: Value<'v>) -> Result<()>

Set the value at index with the new value.

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

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

impl SimpleValue for StarlarkStr