Struct javascriptcore6::Value

pub struct Value { /* private fields */ }

JSCValue represents a reference to a value in a #JSCContext. The JSCValue protects the referenced value from being garbage collected.

Properties

context

The #JSCContext in which the value was created.

Readable | Writeable | Construct Only

GLib type: GObject with reference counted clone semantics.

Implementations

impl Value

pub fn new_array_from_garray(context: &Context, array: &[Value]) -> Value

Create a new #JSCValue referencing an array with the items from @array. If @array is None or empty a new empty array will be created. Elements of @array should be pointers to a #JSCValue.

context

a #JSCContext

array

a #GPtrArray

Returns

a #JSCValue.

pub fn new_array_from_strv(context: &Context, strv: &[&str]) -> Value

Create a new #JSCValue referencing an array of strings with the items from @strv. If @array is None or empty a new empty array will be created.

context

a #JSCContext

strv

a None-terminated array of strings

Returns

a #JSCValue.

pub fn new_boolean(context: &Context, value: bool) -> Value

Create a new #JSCValue from @value

context

a #JSCContext

value

a #gboolean

Returns

a #JSCValue.

pub fn from_json(context: &Context, json: &str) -> Value

Create a new #JSCValue referencing a new value created by parsing @json.

context

a #JSCContext

json

the JSON string to be parsed

Returns

a #JSCValue.

pub fn new_null(context: &Context) -> Value

Create a new #JSCValue referencing null in @context.

context

a #JSCContext

Returns

a #JSCValue.

pub fn new_number(context: &Context, number: f64) -> Value

Create a new #JSCValue from @number.

context

a #JSCContext

number

a number

Returns

a #JSCValue.

pub fn new_string(context: &Context, string: Option<&str>) -> Value

Create a new #JSCValue from @string. If you need to create a #JSCValue from a string containing null characters, use jsc_value_new_string_from_bytes() instead.

context

a #JSCContext

string

a null-terminated string

Returns

a #JSCValue.

pub fn new_string_from_bytes(context: &Context, bytes: Option<&Bytes>) -> Value

Create a new #JSCValue from @bytes.

context

a #JSCContext

bytes

a #GBytes

Returns

a #JSCValue.

pub fn new_typed_array( context: &Context, type_: TypedArrayType, length: usize, ) -> Value

Create a new typed array containing a given amount of elements.

Create a #JSCValue referencing a new typed array with space for @length elements of a given @type_. As all typed arrays must have an associated ArrayBuffer, a new one of suitable size will be allocated to store the elements, which will be initialized to zero.

The @type_ must not be TypedArrayType::None.

context

a #JSCContext

type_

the type of array elements

length

number of elements in the array

Returns

a #JSCValue

pub fn new_undefined(context: &Context) -> Value

Create a new #JSCValue referencing undefined in @context.

context

a #JSCContext

Returns

a #JSCValue.

pub fn array_buffer_get_size(&self) -> usize

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.

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

Invoke new with constructor referenced by @self. If @n_parameters is 0 no parameters will be passed to the constructor.

parameters

the #JSCValues to pass as parameters to the constructor, or None

Returns

a #JSCValue referencing the newly created object instance.

pub 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 #JSCValue, in case of void functions a #JSCValue referencing undefined is returned

parameters

the #JSCValues to pass as parameters to the function, or None

Returns

a #JSCValue with the return value of the function.

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

Get the #JSCContext in which @self was created.

Returns

the #JSCValue context.

pub fn is_array(&self) -> bool

Get whether the value referenced by @self is an array.

Returns

whether the value is an array.

pub fn is_array_buffer(&self) -> bool

Check whether the @self is an ArrayBuffer.

Returns

whether the value is an ArrayBuffer

pub fn is_boolean(&self) -> bool

Get whether the value referenced by @self is a boolean.

Returns

whether the value is a boolean.

pub fn is_constructor(&self) -> bool

Get whether the value referenced by @self is a constructor.

Returns

whether the value is a constructor.

pub fn is_function(&self) -> bool

Get whether the value referenced by @self is a function

Returns

whether the value is a function.

pub fn is_null(&self) -> bool

Get whether the value referenced by @self is null.

Returns

whether the value is null.

pub fn is_number(&self) -> bool

Get whether the value referenced by @self is a number.

Returns

whether the value is a number.

pub fn is_object(&self) -> bool

Get whether the value referenced by @self is an object.

Returns

whether the value is an object.

pub fn is_string(&self) -> bool

Get whether the value referenced by @self is a string

Returns

whether the value is a string

pub fn is_typed_array(&self) -> bool

Determines whether a value is a typed array.

Returns

Whether @self is a typed array.

pub fn is_undefined(&self) -> bool

Get whether the value referenced by @self is undefined.

Returns

whether the value is undefined.

pub fn new_typed_array_with_buffer( &self, type_: TypedArrayType, offset: usize, length: isize, ) -> Option<Value>

Create a new typed array value with elements from an array buffer.

Create a #JSCValue referencing a new typed array value containing elements of the given @type_, where the elements are stored at the memory region represented by the @self.

The @type_ must not be TypedArrayType::None.

The @offset and @length parameters can be used to indicate which part of the array buffer can be accessed through the typed array. If both are omitted (passing zero as @offset, and -1 as @length), the whole @self is exposed through the typed array. Omitting the @length with a non-zero @offset will expose the remainder of the @self starting at the indicated offset.

type_

type of array elements.

offset

offset, in bytes.

length

number of array elements, or -1.

Returns

a #JSCValue

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

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

property_name

the name of the property to define

flags

#JSCValuePropertyFlags

property_value

the default property value

pub 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.

pub 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.

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

Get property with @name from @self.

name

the property name

Returns

the property #JSCValue.

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

Get property at @index from @self.

index

the property index

Returns

the property #JSCValue.

pub 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

pub 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 #JSCValue, in case of void methods a #JSCValue referencing undefined is returned.

name

the method name

parameters

the #JSCValues to pass as parameters to the method, or None

Returns

a #JSCValue with the return value of the method.

pub 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.

pub fn object_set_property(&self, name: &str, property: &Value)

Set @property with @name on @self.

name

the property name

property

the #JSCValue to set

pub fn object_set_property_at_index(&self, index: u32, property: &Value)

Set @property at @index on @self.

index

the property index

property

the #JSCValue to set

pub fn to_boolean(&self) -> bool

Convert @self to a boolean.

Returns

a #gboolean result of the conversion.

pub fn to_double(&self) -> f64

Convert @self to a double.

Returns

a #gdouble result of the conversion.

pub fn to_int32(&self) -> i32

Convert @self to a #gint32.

Returns

a #gint32 result of the conversion.

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

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

pub fn to_str(&self) -> GString

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

Returns

a null-terminated string result of the conversion.

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

Convert @self to a string and return the results as #GBytes. This is needed to handle strings with null characters.

Returns

a #GBytes with the result of the conversion.

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

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

Returns

A #JSCValue

pub fn typed_array_get_length(&self) -> usize

Gets the number of elements in a typed array.

Returns

number of elements.

pub fn typed_array_get_offset(&self) -> usize

Gets the offset over the underlying array buffer data.

Returns

offset, in bytes.

pub fn typed_array_get_size(&self) -> usize

Gets the size of a typed array.

Returns

size, in bytes.

pub fn typed_array_get_type(&self) -> TypedArrayType

Gets the type of elements contained in a typed array.

Returns

type of the elements, or TypedArrayType::None if @self is not a typed array.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Formats the value using the given formatter.

impl HasParamSpec for Value

type ParamSpec = ParamSpecObject

type SetValue = Value

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Value>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Value

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

where H: Hasher,

Hashes the memory address of this object.

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 Ord for Value

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for Value

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Value

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for Value

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 StaticType for Value

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Value