Struct starlark::values::Value

pub struct Value(_);

A value in Starlark.

This is a wrapper around a TypedValue which is cheap to clone and safe to pass around.

Methods

impl Value

pub fn convert_index(&self, len: i64) -> Result<i64, ValueError>

Macro to parse the index for at/set_at methods.

Return an i64 from self corresponding to the index recenterd between 0 and len. Raise the correct errors if the value is not numeric or the index is out of bound.

Examples

Value::new(6).convert_index(7).unwrap() == 6
Value::new(-1).convert_index(7).unwrap() == 6

The following examples would return an error

Value::from("a").convert_index(7) == Err(ValueError::IncorrectParameterType)
Value::new(8).convert_index(7) == Err(ValueError::IndexOutOfBound(8))   // 8 > 7 = len
Value::new(-8).convert_index(7) == Err(ValueError::IndexOutOfBound(-1)) // -8 + 7 = -1 < 0

impl Value

pub fn new<T: TypedValue>(t: T) -> Value

Create a new Value from a static value.

pub fn clone_for_container<T: TypedValue>(
    &self,
    container: &T
) -> Result<Value, ValueError>

Clone for inserting into the other container, using weak reference if we do a recursive insertion.

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

pub fn is_descendant_value(&self, other: &Value) -> bool

Determine if the value pointed by other is a descendant of self

pub fn is_descendant(&self, other: DataPtr) -> bool

pub fn data_ptr(&self) -> DataPtr

Object data pointer.

pub fn function_id(&self) -> FunctionId

Function id used to detect recursion.

impl Value

pub fn freeze(&mut self)

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

pub fn to_str(&self) -> String

pub fn to_rc_string(&self) -> RcString

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

pub fn to_repr(&self) -> String

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

pub fn to_bool(&self) -> bool

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

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

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

pub fn compare(&self, other: &Value) -> Result<Ordering, ValueError>

pub fn call(
    &self,
    call_stack: &mut CallStack,
    type_values: &TypeValues,
    positional: Vec<Value>,
    named: LinkedHashMap<RcString, Value>,
    args: Option<Value>,
    kwargs: Option<Value>
) -> ValueResult

pub fn at(&self, index: Value) -> ValueResult

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

pub fn slice(
    &self,
    start: Option<Value>,
    stop: Option<Value>,
    stride: Option<Value>
) -> ValueResult

pub fn iter(&self) -> Result<RefIterable, ValueError>

pub fn to_vec(&self) -> Result<Vec<Value>, ValueError>

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

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

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

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

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

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

pub fn plus(&self) -> ValueResult

pub fn minus(&self) -> ValueResult

pub fn add(&self, other: Value) -> ValueResult

pub fn sub(&self, other: Value) -> ValueResult

pub fn mul(&self, other: Value) -> ValueResult

pub fn percent(&self, other: Value) -> ValueResult

pub fn div(&self, other: Value) -> ValueResult

pub fn floor_div(&self, other: Value) -> ValueResult

pub fn pipe(&self, other: Value) -> ValueResult

impl Value

pub fn downcast_ref<T: TypedValue>(&self) -> Option<ObjectRef<T>>

Get a reference to underlying data or None if contained object has different type than requested.

This function panics if the Value is borrowed mutably.

pub fn downcast_mut<T: TypedValue<Holder = Mutable<T>>>(
    &self
) -> Result<Option<ObjectRefMut<T>>, ValueError>

Get a mutable reference to underlying data or None if contained object has different type than requested.

This function panics if the Value is borrowed.

Error is returned if the value is frozen or frozen for iteration.

pub fn downcast_rc_str(&self) -> Option<&RcString>

downcast_ref cannot be used, because we are obtaining RcString, not String

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl Eq for Value

impl<'a> From<&'a str> for Value

fn from(a: &'a str) -> Value

Performs the conversion.

impl From<()> for Value

fn from(_a: ()) -> Value

Performs the conversion.

impl<T: Into<Value> + Clone> From<(T,)> for Value

fn from(a: (T,)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone, T5: Into<Value> + Clone, T6: Into<Value> + Clone, T7: Into<Value> + Clone, T8: Into<Value> + Clone, T9: Into<Value> + Clone, T10: Into<Value> + Clone> From<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)> for Value

fn from(a: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone, T5: Into<Value> + Clone, T6: Into<Value> + Clone, T7: Into<Value> + Clone, T8: Into<Value> + Clone, T9: Into<Value> + Clone> From<(T1, T2, T3, T4, T5, T6, T7, T8, T9)> for Value

fn from(a: (T1, T2, T3, T4, T5, T6, T7, T8, T9)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone, T5: Into<Value> + Clone, T6: Into<Value> + Clone, T7: Into<Value> + Clone, T8: Into<Value> + Clone> From<(T1, T2, T3, T4, T5, T6, T7, T8)> for Value

fn from(a: (T1, T2, T3, T4, T5, T6, T7, T8)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone, T5: Into<Value> + Clone, T6: Into<Value> + Clone, T7: Into<Value> + Clone> From<(T1, T2, T3, T4, T5, T6, T7)> for Value

fn from(a: (T1, T2, T3, T4, T5, T6, T7)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone, T5: Into<Value> + Clone, T6: Into<Value> + Clone> From<(T1, T2, T3, T4, T5, T6)> for Value

fn from(a: (T1, T2, T3, T4, T5, T6)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone, T5: Into<Value> + Clone> From<(T1, T2, T3, T4, T5)> for Value

fn from(a: (T1, T2, T3, T4, T5)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone, T4: Into<Value> + Clone> From<(T1, T2, T3, T4)> for Value

fn from(a: (T1, T2, T3, T4)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone, T3: Into<Value> + Clone> From<(T1, T2, T3)> for Value

fn from(a: (T1, T2, T3)) -> Value

Performs the conversion.

impl<T1: Into<Value> + Clone, T2: Into<Value> + Clone> From<(T1, T2)> for Value

fn from(a: (T1, T2)) -> Value

Performs the conversion.

impl From<FunctionArg> for Value

fn from(a: FunctionArg) -> Value

Performs the conversion.

impl From<HashedValue> for Value

fn from(key: HashedValue) -> Value

Performs the conversion.

impl From<NoneType> for Value

fn from(NoneType::None: NoneType) -> Self

Performs the conversion.

impl From<RcString> for Value

fn from(s: RcString) -> Self

Performs the conversion.

impl From<String> for Value

fn from(s: String) -> Self

Performs the conversion.

impl From<Value> for DataPtr

fn from(v: Value) -> Self

Performs the conversion.

impl<T: Into<Value>> From<Vec<T>> for Value

fn from(a: Vec<T>) -> Value

Performs the conversion.

impl From<bool> for Value

fn from(b: bool) -> Self

Performs the conversion.

impl From<i16> for Value

fn from(a: i16) -> Value

Performs the conversion.

impl From<i32> for Value

fn from(a: i32) -> Value

Performs the conversion.

impl From<i64> for Value

fn from(v: i64) -> Self

Performs the conversion.

impl From<i8> for Value

fn from(a: i8) -> Value

Performs the conversion.

impl From<isize> for Value

fn from(a: isize) -> Value

Performs the conversion.

impl From<u16> for Value

fn from(a: u16) -> Value

Performs the conversion.

impl From<u32> for Value

fn from(a: u32) -> Value

Performs the conversion.

impl From<u64> for Value

fn from(a: u64) -> Value

Performs the conversion.

impl From<u8> for Value

fn from(a: u8) -> Value

Performs the conversion.

impl From<usize> for Value

fn from(a: usize) -> Value

Performs the conversion.

impl PartialEq<Value> for Value

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T1: Into<Value> + Eq + Hash + Clone, T2: Into<Value> + Eq + Clone> TryFrom<HashMap<T1, T2, RandomState>> for Value

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(a: HashMap<T1, T2>) -> Result<Value, ValueError>

Performs the conversion.

impl<T1: Into<Value> + Eq + Hash + Clone, T2: Into<Value> + Eq + Clone> TryFrom<LinkedHashMap<T1, T2, RandomState>> for Value

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(a: LinkedHashMap<T1, T2>) -> Result<Value, ValueError>

Performs the conversion.

impl TryParamConvertFromValue for Value

fn try_from(source: Value) -> Result<Self, ValueError>