Struct sciter::value::Value

pub struct Value { /* private fields */ }

sciter::value wrapper.

See the module-level documentation.

Implementations

impl Value

pub const fn new() -> Value

Return a new Sciter value object (undefined).

pub fn array(length: usize) -> Value

Make an explicit array value with the given length.

pub fn map() -> Value

Make an explicit map value.

pub const fn null() -> Value

Make an explicit json null value.

pub const fn nothing() -> Value

Make an explicit nothing (where did it come from?).

pub fn symbol(val: &str) -> Value

Make Sciter symbol value.

pub fn error(val: &str) -> Value

Make Sciter error value.

pub fn color(val: u32) -> Value

Make Sciter color value, in 0xAABBGGRR form.

pub fn duration(val: f64) -> Value

Make Sciter duration value, in seconds.

pub fn angle(val: f64) -> Value

Make Sciter angle value, in radians.

pub fn parse(val: &str) -> Result<Value, usize>

Parse a json string into value. Returns the number of chars left unparsed in case of error.

pub fn parse_as(val: &str, how: VALUE_STRING_CVT_TYPE) -> Result<Value, usize>

Parse a json string into value. Returns the number of chars left unparsed in case of error.

pub fn to_asset<T>(&self) -> Option<&mut IAsset<T>>

Value to asset.

pub fn as_mut_ptr(&mut self) -> *mut VALUE

Returns a raw pointer to the underlaying data.

pub const fn get_type(&self) -> VALUE_TYPE

Get the inner type of the value.

pub const fn full_type(&self) -> (VALUE_TYPE, UINT)

Get the inner type and its subtype (e.g. units) of the value.

pub fn isolate(&mut self)

Convert T_OBJECT value type to JSON T_MAP or T_ARRAY types.

Also must be used if you need to pass values between different threads.

pub fn clear(&mut self) -> &mut Value

Clear the value. It deallocates all assosiated structures that are not used anywhere else.

pub fn len(&self) -> usize

Return the number of items in the T_ARRAY, T_MAP, T_FUNCTION and T_OBJECT value types.

pub fn push<T: Into<Value>>(&mut self, src: T)

Append another value to the end of T_ARRAY value.

pub fn set<T: Into<Value>>(&mut self, index: usize, src: T)

Insert or set value at the given index of T_ARRAY, T_MAP, T_FUNCTION and T_OBJECT value.

pub fn get(&self, index: usize) -> Value

Retreive value of sub-element at index.

• T_ARRAY - nth element of the array;
• T_MAP - value of the nth key/value pair in the map;
• T_FUNCTION - value of the nth argument of the function.

pub fn set_item<TKey: Into<Value>, TValue: Into<Value>>(
    &mut self,
    key: TKey,
    value: TValue
)

Insert or set value of the sub-element by key.

• T_MAP - sets named value in the map;
• T_OBJECT - sets value of property of the object;
• T_FUNCTION - sets named argument of the function;
• otherwise it converts self to the map type and adds the key/value to it.

pub fn get_item<T: Into<Value>>(&self, key: T) -> Value

Retrieve the value of a sub-element by key.

pub fn key_at(&self, index: usize) -> Value

Retrieve the key of a sub-element by index.

pub fn keys(&self) -> KeyIterator<'_>

An iterator visiting all keys of key/value pairs in the map.

• T_MAP - keys of key/value pairs in the map;
• T_OBJECT - names of key/value properties in the object;
• T_FUNCTION - names of arguments of the function (if any).

The iterator element type is Value (as a key).

pub fn values(&self) -> SeqIterator<'_>

An iterator visiting all values in arbitrary order.

• T_ARRAY - elements of the array;
• T_MAP - values of key/value pairs in the map;
• T_OBJECT - values of key/value properties in the object;
• T_FUNCTION - values of arguments of the function.

The iterator element type is Value.

pub fn items(&self) -> Vec<(Value, Value)>

An iterator visiting all key-value pairs in arbitrary order.

The Value must has a key-value type (map, object, function).

The iterator element type is (Value, Value).

pub fn to_int(&self) -> Option<i32>

Value to integer.

pub fn to_bool(&self) -> Option<bool>

Value to bool.

pub fn to_float(&self) -> Option<f64>

Value to float.

pub fn to_color(&self) -> Option<u32>

Value to color.

pub fn to_duration(&self) -> Option<f64>

Value to duration.

pub fn to_angle(&self) -> Option<f64>

Value to angle.

pub fn as_string(&self) -> Option<String>

Value as string for T_STRING type.

pub fn into_string(self) -> String

Value to json string (converted in-place). Subject to change.

pub fn as_bytes(&self) -> Option<&[u8]>

Value as a byte slice for T_BYTES type.

pub fn to_bytes(&self) -> Option<Vec<u8>>

Value to byte vector for T_BYTES type.

pub fn call(
    &self,
    this: Option<Value>,
    args: &[Value],
    name: Option<&str>
) -> Result<Value, VALUE_RESULT>

Function invocation for T_OBJECT with UT_OBJECT_FUNCTION value type.

Calls the tiscript function or method holded at Value with context of this object that will be known as this inside that function (it is optional for global functions).

The name here is an url or a name of the script - used for error reporting in script.

You can use the make_args!(args...) macro which helps you to construct script arguments from Rust types.

pub fn is_empty(&self) -> bool

Returns true is self is undefined or has zero elements.

pub const fn is_undefined(&self) -> bool

pub const fn is_null(&self) -> bool

pub const fn is_nothing(&self) -> bool

pub const fn is_bool(&self) -> bool

pub const fn is_int(&self) -> bool

pub const fn is_float(&self) -> bool

pub const fn is_bytes(&self) -> bool

pub const fn is_string(&self) -> bool

pub const fn is_symbol(&self) -> bool

pub const fn is_error_string(&self) -> bool

pub const fn is_date(&self) -> bool

pub const fn is_currency(&self) -> bool

pub const fn is_color(&self) -> bool

pub const fn is_duration(&self) -> bool

pub const fn is_angle(&self) -> bool

pub const fn is_map(&self) -> bool

pub const fn is_array(&self) -> bool

pub const fn is_function(&self) -> bool

pub fn is_native_function(&self) -> bool

pub const fn is_object(&self) -> bool

pub const fn is_asset(&self) -> bool

pub const fn is_primitive(&self) -> bool

I.e. non-reference types that do not need a destructor.

pub const fn is_object_array(&self) -> bool

pub const fn is_object_map(&self) -> bool

pub const fn is_object_class(&self) -> bool

pub const fn is_object_native(&self) -> bool

pub const fn is_object_function(&self) -> bool

pub const fn is_object_error(&self) -> bool

pub const fn is_dom_element(&self) -> bool

pub const fn is_varray(&self) -> bool

pub const fn is_vmap(&self) -> bool

pub fn is_vfunction(&self) -> bool

pub const fn is_verror(&self) -> bool

Trait Implementations

impl Clone for Value

Copies value.

All allocated objects are reference counted so copying is just a matter of increasing reference counts.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

Print Value as json string with explicit type showed.

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

Formats the value using the given formatter.

impl Default for Value

Return default value (undefined).

fn default() -> Self

Returns the “default value” for a type.

impl Display for Value

Print Value as json string

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

Formats the value using the given formatter.

impl Drop for Value

Destroy pointed value.

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'_ bool> for Value

Value from bool.

fn from(val: &bool) -> Self

Performs the conversion.

impl From<&'_ f64> for Value

Value from float.

fn from(val: &f64) -> Self

Performs the conversion.

impl From<&'_ i32> for Value

Value from integer.

fn from(val: &i32) -> Self

Performs the conversion.

impl<'a> From<&'a [u8]> for Value

Value from binary array (sequence of bytes).

fn from(val: &'a [u8]) -> Self

Performs the conversion.

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

fn from(val: &'a String) -> Self

Performs the conversion.

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

Value from a native VALUE object.

fn from(val: &'a VALUE) -> Self

Performs the conversion.

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

Value from string.

fn from(val: &'a str) -> Self

Performs the conversion.

impl From<()> for Value

Value from nothing (()) for empty return values.

Returns undefined value.

fn from(_: ()) -> Self

Performs the conversion.

impl<T> From<Box<IAsset<T>, Global>> for Value

Value from asset.

fn from(ptr: Box<IAsset<T>>) -> Value

Performs the conversion.

impl<F, R> From<F> for Value where
    F: Fn(&[Value]) -> R,
    R: Into<Value>, 

Value from function.

fn from(f: F) -> Value

Performs the conversion.

impl From<Graphics> for Value

Store the Graphics object as a Value.

fn from(i: Graphics) -> Value

Performs the conversion.

impl From<Image> for Value

Store the Image object as a Value.

fn from(i: Image) -> Value

Performs the conversion.

impl From<Path> for Value

Store the Path object as a Value.

fn from(i: Path) -> Value

Performs the conversion.

impl<T, E> From<Result<T, E>> for Value where
    T: Into<Value>,
    E: Display, 

Value from Result.

fn from(val: Result<T, E>) -> Self

Performs the conversion.

impl From<String> for Value

Value from string.

fn from(val: String) -> Self

Performs the conversion.

impl From<SystemTime> for Value

Value from time/date.

fn from(val: SystemTime) -> Self

See the [VALUE_TIME::T_DATE].

impl From<Text> for Value

Store the Text object as a Value.

fn from(i: Text) -> Value

Performs the conversion.

impl From<bool> for Value

Value from bool.

fn from(val: bool) -> Self

Performs the conversion.

impl From<f64> for Value

Value from float.

fn from(val: f64) -> Self

Performs the conversion.

impl From<i32> for Value

Value from integer.

fn from(val: i32) -> Self

Performs the conversion.

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

Value from sequence of &str.

fn from_iter<I: IntoIterator<Item = &'a str>>(iterator: I) -> Self

Creates a value from an iterator.

impl FromIterator<String> for Value

Value from sequence of String.

fn from_iter<I: IntoIterator<Item = String>>(iterator: I) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for Value

Value from sequence of Value.

fn from_iter<I: IntoIterator<Item = Value>>(iterator: I) -> Self

Creates a value from an iterator.

impl FromIterator<f64> for Value

Value from sequence of f64.

fn from_iter<I: IntoIterator<Item = f64>>(iterator: I) -> Self

Creates a value from an iterator.

impl FromIterator<i32> for Value

Value from sequence of i32.

fn from_iter<I: IntoIterator<Item = i32>>(iterator: I) -> Self

Creates a value from an iterator.

impl FromStr for Value

Value from json string.

type Err = VALUE_RESULT

The associated error which can be returned from parsing.

fn from_str(val: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromValue for Value

fn from_value(v: &Value) -> Option<Self>

Converts value to specified type.

impl Index<&'static str> for Value

Get item by string key for map type.

type Output = Value

The returned type after indexing.

fn index(&self, key: &'static str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Value> for Value

Get item by key for map type.

type Output = Value

The returned type after indexing.

fn index(&self, key: Value) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Value

Get item by index for array type.

type Output = Value

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Value

Conversion into an Iterator.

Adds the for loop syntax support: for subitem in &value {].

type Item = Value

The type of the elements being iterated over.

type IntoIter = SeqIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Value> for Value

Compare two values.

fn eq(&self, other: &Self) -> 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 !=.

impl TryFrom<Element> for Value

Store the DOM element as a Value.

Since 4.4.3.26, perhaps.

type Error = SCDOM_RESULT

The type returned in the event of a conversion error.

fn try_from(e: Element) -> Result<Value>

Performs the conversion.

impl Send for Value

sciter::Value can be transferred across thread boundaries.