Enum Value

pub enum Value {
    Invalid,
    Nil,
    Bool(bool),
    Number(f64),
    String(RcStr),
    List(Rc<List>),
    Set(Rc<Set>),
    Map(Rc<Map>),
    Table(Rc<Table>),
    Function(Rc<Function>),
    NativeFunction(Rc<NativeFunction>),
    Generator(Rc<RefCell<Generator>>),
    NativeGenerator(Rc<RefCell<NativeGenerator>>),
    Class(Rc<Class>),
    Module(Rc<Module>),
    Handle(Rc<HandleData>),
}

Variants

Invalid

Nil

Bool(bool)

Number(f64)

String(RcStr)

List(Rc<List>)

Set(Rc<Set>)

Map(Rc<Map>)

Table(Rc<Table>)

Function(Rc<Function>)

NativeFunction(Rc<NativeFunction>)

Generator(Rc<RefCell<Generator>>)

NativeGenerator(Rc<RefCell<NativeGenerator>>)

Class(Rc<Class>)

Module(Rc<Module>)

Handle(Rc<HandleData>)

Implementations

impl Value

pub fn f64(&self) -> Result<f64, Error>

pub fn f32(&self) -> Result<f32, Error>

pub fn usize(&self) -> Result<usize, Error>

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

pub fn u32(&self) -> Result<u32, Error>

pub fn u16(&self) -> Result<u16, Error>

pub fn u8(&self) -> Result<u8, Error>

pub fn isize(&self) -> Result<isize, Error>

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

pub fn i32(&self) -> Result<i32, Error>

pub fn i16(&self) -> Result<i16, Error>

pub fn i8(&self) -> Result<i8, Error>

impl Value

pub fn format_string(fmt: &str, args: Vec<Value>) -> Result<String, Error>

impl Value

Methods for dealing with unpacking values in other values

the easy_* variants are those where a Globals context is not used, but can only unpack List, Set and Map values.

Some of these methods are kind of redundant with many of the TryFrom forms. Some of these redundant unpack methods may be removed in the future.

pub fn unpack_into_set( self, globals: &mut Globals, ) -> Result<IndexSet<Key>, Error>

pub fn unpack_into_map( self, globals: &mut Globals, ) -> Result<IndexMap<Key, Value>, Error>

pub fn unpack(self, globals: &mut Globals) -> Result<Vec<Value>, Error>

pub fn unpack_into<C, T, E>(self, globals: &mut Globals) -> Result<C, Error>

where C: FromIterator<T>, T: TryFrom<Value, Error = E>, Error: From<E>,

pub fn easy_unpack(self) -> Result<Vec<Value>, Error>

pub fn easy_unpack2(self) -> Result<[Value; 2], Error>

pub fn easy_unpack3(self) -> Result<[Value; 3], Error>

pub fn easy_unpack4(self) -> Result<[Value; 4], Error>

pub fn unpack_keyval(self, globals: &mut Globals) -> Result<(Key, Value), Error>

pub fn unpack2(self, globals: &mut Globals) -> Result<[Value; 2], Error>

pub fn unpack3(self, globals: &mut Globals) -> Result<[Value; 3], Error>

pub fn unpack4(self, globals: &mut Globals) -> Result<[Value; 4], Error>

impl Value

pub fn easy_iter_unpack<F, R>(&self, f: F) -> Result<R, Error>

where F: FnOnce(EasyIterUnpack<'_>) -> Result<R, Error>,

impl Value

pub fn convert<T>(self, globals: &mut Globals) -> Result<T, Error>

where T: Any + ConvertValue + Clone,

For converting to a native value into a value of the desired type. If the current value is a handle of the given type, it will either unwrap or clone it. If not, it will try to convert it with the ConvertValue trait

pub fn to_xref<T>(&self, globals: &mut Globals) -> Result<XRef<'_, T>, Error>

where T: Any + ConvertValue,

pub fn to_xref_mut<T>( &self, globals: &mut Globals, ) -> Result<XRefMut<'_, T>, Error>

where T: Any + ConvertValue,

impl Value

pub fn truthy(&self) -> bool

pub fn debug_typename(&self) -> RcStr

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

pub fn lt(&self, other: &Value) -> Result<bool, Error>

pub fn is_nil(&self) -> bool

pub fn bool(&self) -> Result<bool, Error>

pub fn number(&self) -> Result<f64, Error>

pub fn string(&self) -> Result<&RcStr, Error>

pub fn into_string(self) -> Result<RcStr, Error>

pub fn list(&self) -> Result<&Rc<List>, Error>

pub fn into_list(self) -> Result<Rc<List>, Error>

pub fn set(&self) -> Result<&Rc<Set>, Error>

pub fn into_set(self) -> Result<Rc<Set>, Error>

pub fn map(&self) -> Result<&Rc<Map>, Error>

pub fn into_map(self) -> Result<Rc<Map>, Error>

pub fn function(&self) -> Result<&Rc<Function>, Error>

pub fn is_function(&self) -> bool

pub fn into_function(self) -> Result<Rc<Function>, Error>

pub fn native_function(&self) -> Result<&Rc<NativeFunction>, Error>

pub fn is_native_function(&self) -> bool

pub fn into_native_function(self) -> Result<Rc<NativeFunction>, Error>

pub fn class(&self) -> Result<&Rc<Class>, Error>

pub fn into_class(self) -> Result<Rc<Class>, Error>

pub fn module(&self) -> Result<&Rc<Module>, Error>

pub fn into_module(self) -> Result<Rc<Module>, Error>

pub fn into_handle<T>(self) -> Result<Handle<T>, Error>

where T: Any,

pub fn is_handle<T>(&self) -> bool

where T: Any,

pub fn unwrap_handle<T>(self) -> Result<T, Error>

where T: Any,

pub fn unwrap_or_clone_handle<T>(self) -> Result<T, Error>

where T: Any + Clone,

pub fn convert_to_int(self) -> Result<i64, Error>

pub fn convert_to_float(self) -> Result<f64, Error>

pub fn convert_to_rcstr(self) -> RcStr

pub fn unwrap_or_clone_string(self) -> Result<String, Error>

pub fn iter(self, _globals: &mut Globals) -> Result<Value, Error>

pub fn get_class<'a>(&'a self, globals: &'a Globals) -> &'a Rc<Class>

pub fn getattr_opt(&self, attr: &RcStr) -> Option<Value>

pub fn getattr(&self, attr: &RcStr) -> Result<Value, Error>

pub fn getattrs(&self) -> Vec<RcStr>

pub fn setattr(&self, attr: &RcStr, value: Value) -> Result<(), Error>

pub fn apply( &self, globals: &mut Globals, args: Vec<Value>, kwargs: Option<HashMap<RcStr, Value>>, ) -> Result<Value, Error>

pub fn apply_method<M>( &self, globals: &mut Globals, method_name: &M, args: Vec<Value>, kwargs: Option<HashMap<RcStr, Value>>, ) -> Result<Value, Error>

where M: Hash + Eq + Debug + ?Sized, RcStr: Borrow<M>,

pub fn resume(&self, globals: &mut Globals, arg: Value) -> ResumeResult

pub fn to_index(&self, len: usize) -> Result<usize, Error>

pub fn to_slice_index(&self, len: usize) -> Result<usize, Error>

pub fn to_start_index(&self, len: usize) -> Result<usize, Error>

pub fn to_end_index(&self, len: usize) -> Result<usize, Error>

pub fn getitem( &self, globals: &mut Globals, index: Value, ) -> Result<Value, Error>

pub fn setitem( &self, globals: &mut Globals, index: Value, value: Value, ) -> Result<(), Error>

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<(), Error>

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 From<&ConstVal> for Value

fn from(cv: &ConstVal) -> Value

Converts to this type from the input type.

impl From<&Key> for Value

fn from(key: &Key) -> Value

Converts to this type from the input type.

impl From<&Rc<Class>> for Value

fn from(cls: &Rc<Class>) -> Value

Converts to this type from the input type.

impl From<&Rc<Function>> for Value

fn from(f: &Rc<Function>) -> Value

Converts to this type from the input type.

impl From<&Rc<Module>> for Value

fn from(m: &Rc<Module>) -> Value

Converts to this type from the input type.

impl From<&Rc<NativeFunction>> for Value

fn from(f: &Rc<NativeFunction>) -> Value

Converts to this type from the input type.

impl From<&Rc<Table>> for Value

fn from(obj: &Rc<Table>) -> Value

Converts to this type from the input type.

impl From<&RcStr> for Value

fn from(s: &RcStr) -> Value

Converts to this type from the input type.

impl From<&String> for Value

fn from(s: &String) -> Value

Converts to this type from the input type.

impl From<&str> for Value

fn from(s: &str) -> Value

Converts to this type from the input type.

impl From<(&Key, &Value)> for Value

fn from(kv: (&Key, &Value)) -> Value

Converts to this type from the input type.

impl From<()> for Value

fn from(_: ()) -> Value

Converts to this type from the input type.

impl<A, B> From<(A, B)> for Value

where Value: From<A> + From<B>,

fn from(kv: (A, B)) -> Value

Converts to this type from the input type.

impl From<ConstVal> for Value

fn from(cv: ConstVal) -> Value

Converts to this type from the input type.

impl From<Error> for Value

fn from(error: Error) -> Value

Converts to this type from the input type.

impl From<Function> for Value

fn from(f: Function) -> Value

Converts to this type from the input type.

impl From<Generator> for Value

fn from(gen: Generator) -> Value

Converts to this type from the input type.

impl<T> From<Handle<T>> for Value

where T: Any,

fn from(handle: Handle<T>) -> Value

Converts to this type from the input type.

impl From<HashMap<RcStr, Value>> for Value

fn from(map: HashMap<RcStr, Value>) -> Value

Converts to this type from the input type.

impl From<IndexMap<Key, Value>> for Value

fn from(map: IndexMap<Key, Value>) -> Value

Converts to this type from the input type.

impl From<IndexSet<Key>> for Value

fn from(set: IndexSet<Key>) -> Value

Converts to this type from the input type.

impl From<Key> for Value

fn from(key: Key) -> Value

Converts to this type from the input type.

impl From<Map> for Value

fn from(map: Map) -> Value

Converts to this type from the input type.

impl From<NativeFunction> for Value

fn from(f: NativeFunction) -> Value

Converts to this type from the input type.

impl From<NativeGenerator> for Value

fn from(gen: NativeGenerator) -> Value

Converts to this type from the input type.

impl From<Rc<Class>> for Value

fn from(cls: Rc<Class>) -> Value

Converts to this type from the input type.

impl From<Rc<Function>> for Value

fn from(f: Rc<Function>) -> Value

Converts to this type from the input type.

impl From<Rc<Module>> for Value

fn from(m: Rc<Module>) -> Value

Converts to this type from the input type.

impl From<Rc<NativeFunction>> for Value

fn from(f: Rc<NativeFunction>) -> Value

Converts to this type from the input type.

impl From<Rc<Table>> for Value

fn from(obj: Rc<Table>) -> Value

Converts to this type from the input type.

impl From<RcStr> for Value

fn from(s: RcStr) -> Value

Converts to this type from the input type.

impl From<Set> for Value

fn from(set: Set) -> Value

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Value

Converts to this type from the input type.

impl From<Table> for Value

fn from(obj: Table) -> Value

Converts to this type from the input type.

impl From<Vec<Value>> for Value

fn from(vec: Vec<Value>) -> Value

Converts to this type from the input type.

impl From<bool> for Value

fn from(x: bool) -> Value

Converts to this type from the input type.

impl From<char> for Value

fn from(c: char) -> Value

Converts to this type from the input type.

impl From<f32> for Value

fn from(x: f32) -> Value

Converts to this type from the input type.

impl From<f64> for Value

fn from(x: f64) -> Value

Converts to this type from the input type.

impl From<i16> for Value

fn from(x: i16) -> Value

Converts to this type from the input type.

impl From<i32> for Value

fn from(x: i32) -> Value

Converts to this type from the input type.

impl From<i64> for Value

fn from(x: i64) -> Value

Converts to this type from the input type.

impl From<i8> for Value

fn from(x: i8) -> Value

Converts to this type from the input type.

impl From<isize> for Value

fn from(x: isize) -> Value

Converts to this type from the input type.

impl From<u16> for Value

fn from(x: u16) -> Value

Converts to this type from the input type.

impl From<u32> for Value

fn from(x: u32) -> Value

Converts to this type from the input type.

impl From<u64> for Value

fn from(x: u64) -> Value

Converts to this type from the input type.

impl From<u8> for Value

fn from(x: u8) -> Value

Converts to this type from the input type.

impl From<usize> for Value

fn from(x: usize) -> Value

Converts to this type from the input type.

impl FromIterator<Value> for List

fn from_iter<I>(iter: I) -> List

where I: IntoIterator<Item = Value>,

Creates a value from an iterator.

impl PartialEq for Value

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Value

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&OsStr> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &OsStr) -> Result<Value, Error>

Performs the conversion.

impl TryFrom<&OsString> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &OsString) -> Result<Value, Error>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value) -> Result<&'a str, Error>

Performs the conversion.

impl TryFrom<&Value> for Key

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Key, Error>

Performs the conversion.

impl TryFrom<&Value> for RcStr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<RcStr, Error>

Performs the conversion.

impl TryFrom<OsString> for Value

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: OsString) -> Result<Value, Error>

Performs the conversion.

impl TryFrom<Value> for Encoding

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Encoding, Error>

Performs the conversion.

impl TryFrom<Value> for Error

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Error, Error>

Performs the conversion.

impl TryFrom<Value> for Key

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Key, Error>

Performs the conversion.

impl TryFrom<Value> for RcStr

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<RcStr, Error>

Performs the conversion.

impl<T, E> TryFrom<Value> for Vec<T>

where T: TryFrom<Value, Error = E>, Error: From<E>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Vec<T>, Error>

Performs the conversion.

impl StructuralPartialEq for Value