Trait javascriptcore::prelude::ValueExt

pub trait ValueExt: 'static {
    fn array_buffer_get_size(&self) -> usize;
    fn constructor_callv(&self, parameters: &[Value]) -> Option<Value>;
    fn function_callv(&self, parameters: &[Value]) -> Option<Value>;
    fn context(&self) -> Option<Context>;
    fn is_array(&self) -> bool;
    fn is_array_buffer(&self) -> bool;
    fn is_boolean(&self) -> bool;
    fn is_constructor(&self) -> bool;
    fn is_function(&self) -> bool;
    fn is_null(&self) -> bool;
    fn is_number(&self) -> bool;
    fn is_object(&self) -> bool;
    fn is_string(&self) -> bool;
    fn is_typed_array(&self) -> bool;
    fn is_undefined(&self) -> bool;
    fn object_define_property_data(
        &self,
        property_name: &str,
        flags: ValuePropertyFlags,
        property_value: Option<&impl IsA<Value>>
    );
    fn object_delete_property(&self, name: &str) -> bool;
    fn object_enumerate_properties(&self) -> Vec<GString>;
    fn object_get_property(&self, name: &str) -> Option<Value>;
    fn object_get_property_at_index(&self, index: u32) -> Option<Value>;
    fn object_has_property(&self, name: &str) -> bool;
    fn object_invoke_methodv(
        &self,
        name: &str,
        parameters: &[Value]
    ) -> Option<Value>;
    fn object_is_instance_of(&self, name: &str) -> bool;
    fn object_set_property(&self, name: &str, property: &impl IsA<Value>);
    fn object_set_property_at_index(&self, index: u32, property: &impl IsA<Value>);
    fn to_boolean(&self) -> bool;
    fn to_double(&self) -> f64;
    fn to_int32(&self) -> i32;
    fn to_json(&self, indent: u32) -> Option<GString>;
    fn to_str(&self) -> GString;
    fn to_string_as_bytes(&self) -> Option<Bytes>;
    fn typed_array_get_buffer(&self) -> Option<Value>;
    fn typed_array_get_length(&self) -> usize;
    fn typed_array_get_offset(&self) -> usize;
    fn typed_array_get_size(&self) -> usize;
}

Trait containing all Value methods.

Implementors

Value

Required Methods

fn array_buffer_get_size(&self) -> usize

Available on crate feature v2_38 only.

Gets the size in bytes of the array buffer.

Obtains the size in bytes of the memory region that holds the contents of an ArrayBuffer.

Returns

size, in bytes.

fn constructor_callv(&self, parameters: &[Value]) -> Option<Value>

Invoke <function>new</function> with constructor referenced by self. If n_parameters is 0 no parameters will be passed to the constructor.

parameters

the Values to pass as parameters to the constructor, or None

Returns

a Value referencing the newly created object instance.

fn function_callv(&self, parameters: &[Value]) -> Option<Value>

Call function referenced by self, passing the given parameters. If n_parameters is 0 no parameters will be passed to the function.

This function always returns a Value, in case of void functions a Value referencing <function>undefined</function> is returned

parameters

the Values to pass as parameters to the function, or None

Returns

a Value with the return value of the function.

fn context(&self) -> Option<Context>

Get the Context in which self was created.

Returns

the Value context.

fn is_array(&self) -> bool

Get whether the value referenced by self is an array.

Returns

whether the value is an array.

fn is_array_buffer(&self) -> bool

Available on crate feature v2_38 only.

Check whether the self is an ArrayBuffer.

Returns

whether the value is an ArrayBuffer

fn is_boolean(&self) -> bool

Get whether the value referenced by self is a boolean.

Returns

whether the value is a boolean.

fn is_constructor(&self) -> bool

Get whether the value referenced by self is a constructor.

Returns

whether the value is a constructor.

fn is_function(&self) -> bool

Get whether the value referenced by self is a function

Returns

whether the value is a function.

fn is_null(&self) -> bool

Get whether the value referenced by self is <function>null</function>.

Returns

whether the value is null.

fn is_number(&self) -> bool

Get whether the value referenced by self is a number.

Returns

whether the value is a number.

fn is_object(&self) -> bool

Get whether the value referenced by self is an object.

Returns

whether the value is an object.

fn is_string(&self) -> bool

Get whether the value referenced by self is a string

Returns

whether the value is a string

fn is_typed_array(&self) -> bool

Available on crate feature v2_38 only.

Determines whether a value is a typed array.

Returns

Whether self is a typed array.

fn is_undefined(&self) -> bool

Get whether the value referenced by self is <function>undefined</function>.

Returns

whether the value is undefined.

fn object_define_property_data(
    &self,
    property_name: &str,
    flags: ValuePropertyFlags,
    property_value: Option<&impl IsA<Value>>
)

Define or modify a property with property_name in object referenced by self. This is equivalent to JavaScript <function>Object.defineProperty()</function> when used with a data descriptor.

property_name

the name of the property to define

flags

ValuePropertyFlags

property_value

the default property value

fn object_delete_property(&self, name: &str) -> bool

Try to delete property with name from self. This function will return false if the property was defined without ValuePropertyFlags::CONFIGURABLE flag.

name

the property name

Returns

true if the property was deleted, or false otherwise.

fn object_enumerate_properties(&self) -> Vec<GString>

Get the list of property names of self. Only properties defined with ValuePropertyFlags::ENUMERABLE flag will be collected.

Returns

a None-terminated array of strings containing the property names, or None if self doesn’t have enumerable properties. Use g_strfreev() to free.

fn object_get_property(&self, name: &str) -> Option<Value>

Get property with name from self.

name

the property name

Returns

the property Value.

fn object_get_property_at_index(&self, index: u32) -> Option<Value>

Get property at index from self.

index

the property index

Returns

the property Value.

fn object_has_property(&self, name: &str) -> bool

Get whether self has property with name.

name

the property name

Returns

true if self has a property with name, or false otherwise

fn object_invoke_methodv(&self, name: &str, parameters: &[Value]) -> Option<Value>

Invoke method with name on object referenced by self, passing the given parameters. If n_parameters is 0 no parameters will be passed to the method. The object instance will be handled automatically even when the method is a custom one registered with jsc_class_add_method(), so it should never be passed explicitly as parameter of this function.

This function always returns a Value, in case of void methods a Value referencing <function>undefined</function> is returned.

name

the method name

parameters

the Values to pass as parameters to the method, or None

Returns

a Value with the return value of the method.

fn object_is_instance_of(&self, name: &str) -> bool

Get whether the value referenced by self is an instance of class name.

name

a class name

Returns

whether the value is an object instance of class name.

fn object_set_property(&self, name: &str, property: &impl IsA<Value>)

Set property with name on self.

name

the property name

property

the Value to set

fn object_set_property_at_index(&self, index: u32, property: &impl IsA<Value>)

Set property at index on self.

index

the property index

property

the Value to set

fn to_boolean(&self) -> bool

Convert self to a boolean.

Returns

a gboolean result of the conversion.

fn to_double(&self) -> f64

Convert self to a double.

Returns

a gdouble result of the conversion.

fn to_int32(&self) -> i32

Convert self to a gint32.

Returns

a gint32 result of the conversion.

fn to_json(&self, indent: u32) -> Option<GString>

Available on crate feature v2_28 only.

Create a JSON string of self serialization. If indent is 0, the resulting JSON will not contain newlines. The size of the indent is clamped to 10 spaces.

indent

The number of spaces to indent when nesting.

Returns

a null-terminated JSON string with serialization of self

fn to_str(&self) -> GString

Convert self to a string. Use to_string_as_bytes() instead, if you need to handle strings containing null characters.

Returns

a null-terminated string result of the conversion.

fn to_string_as_bytes(&self) -> Option<Bytes>

Convert self to a string and return the results as glib::Bytes. This is needed to handle strings with null characters.

Returns

a glib::Bytes with the result of the conversion.

fn typed_array_get_buffer(&self) -> Option<Value>

Available on crate feature v2_38 only.

Obtain the ArrayBuffer for the memory region of the typed array elements.

Returns

A Value

fn typed_array_get_length(&self) -> usize

Available on crate feature v2_38 only.

Gets the number of elements in a typed array.

Returns

number of elements.

fn typed_array_get_offset(&self) -> usize

Available on crate feature v2_38 only.

Gets the offset over the underlying array buffer data.

Returns

offset, in bytes.

fn typed_array_get_size(&self) -> usize

Available on crate feature v2_38 only.

Gets the size of a typed array.

Returns

size, in bytes.

Implementors

impl<O: IsA<Value>> ValueExt for O