Type Alias starlark::values::StringValue

pub type StringValue<'v> = ValueTyped<'v, StarlarkStr>;

Convenient type alias.

We use ValueTyped<StarlarkStr> often, but also we define more operations on ValueTyped<StarlarkStr> than on generic ValueTyped<T>.

Aliased Type

struct StringValue<'v>(/* private fields */);

Implementations

impl<'v> StringValue<'v>

pub fn freeze(self, freezer: &Freezer) -> Result<FrozenStringValue>

Convert a value to a FrozenStringValue using a supplied Freezer.

pub fn get_hashed(self) -> Hashed<Self>

Get self along with the hash.

pub fn get_hashed_str(self) -> Hashed<&'v str>

Get the string reference along with the hash.

pub fn get_hashed_value(self) -> Hashed<Value<'v>>

Get the Value along with the hash.

pub fn unpack_frozen(self) -> Option<FrozenStringValue>

If this string value is frozen, return it.

Trait Implementations

impl<'v> Borrow<str> for StringValue<'v>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'v> Default for StringValue<'v>

fn default() -> Self

Returns the “default value” for a type.

impl<'v> Equivalent<FrozenValueTyped<'static, StarlarkStr>> for StringValue<'v>

fn equivalent(&self, key: &FrozenStringValue) -> bool

Compare self to key and return true if they are equal.

impl<'v> Freeze for StringValue<'v>

type Frozen = FrozenValueTyped<'static, StarlarkStr>

When type is frozen, it is frozen into this type.

fn freeze(self, freezer: &Freezer) -> Result<FrozenStringValue>

Freeze a value. The frozen value must be equal to the original, and produce the same hash.

impl<'v> Hash for StringValue<'v>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'v> Ord for StringValue<'v>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'v> PartialEq<FrozenValueTyped<'static, StarlarkStr>> for StringValue<'v>

fn eq(&self, other: &FrozenStringValue) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'v> PartialOrd for StringValue<'v>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'v> StringValueLike<'v> for StringValue<'v>

fn to_string_value(self) -> StringValue<'v>

Convert to a StringValue.

fn as_str(self) -> &'v str

Convert to a str.