Struct javascriptcore6::Context

pub struct Context { /* private fields */ }

JSCContext represents a JavaScript execution context, where all operations take place and where the values will be associated.

When a new context is created, a global object is allocated and the built-in JavaScript objects (Object, Function, String, Array) are populated. You can execute JavaScript in the context by using jsc_context_evaluate() or jsc_context_evaluate_with_source_uri(). It’s also possible to register custom objects in the context with jsc_context_register_class().

Properties

virtual-machine

The #JSCVirtualMachine in which the context was created.

Readable | Writeable | Construct Only

GLib type: GObject with reference counted clone semantics.

Implementations

impl Context

pub fn new() -> Context

Create a new #JSCContext. The context is created in a new #JSCVirtualMachine. Use jsc_context_new_with_virtual_machine() to create a new #JSCContext in an existing #JSCVirtualMachine.

Returns

the newly created #JSCContext.

pub fn with_virtual_machine(vm: &VirtualMachine) -> Context

Create a new #JSCContext in @virtual_machine.

vm

a #JSCVirtualMachine

Returns

the newly created #JSCContext.

pub fn check_syntax( &self, code: &str, mode: CheckSyntaxMode, uri: &str, line_number: u32, ) -> (CheckSyntaxResult, Exception)

Check the given @code in @self for syntax errors. The @line_number is the starting line number in @uri; the value is one-based so the first line is 1. @uri and @line_number are only used to fill the @exception. In case of errors @exception will be set to a new #JSCException with the details. You can pass None to @exception to ignore the error details.

code

a JavaScript script to check

length

length of @code, or -1 if @code is a nul-terminated string

mode

a #JSCCheckSyntaxMode

uri

the source URI

line_number

the starting line number

Returns

a #JSCCheckSyntaxResult

exception

return location for a #JSCException, or None to ignore

pub fn clear_exception(&self)

Clear the uncaught exception in @self if any.

pub fn evaluate(&self, code: &str) -> Option<Value>

Evaluate @code in @self.

code

a JavaScript script to evaluate

length

length of @code, or -1 if @code is a nul-terminated string

Returns

a #JSCValue representing the last value generated by the script.

pub fn evaluate_with_source_uri( &self, code: &str, uri: &str, line_number: u32, ) -> Option<Value>

Evaluate @code in @self using @uri as the source URI. The @line_number is the starting line number in @uri; the value is one-based so the first line is 1. @uri and @line_number will be shown in exceptions and they don’t affect the behavior of the script.

code

a JavaScript script to evaluate

length

length of @code, or -1 if @code is a nul-terminated string

uri

the source URI

line_number

the starting line number

Returns

a #JSCValue representing the last value generated by the script.

pub fn exception(&self) -> Option<Exception>

Get the last unhandled exception thrown in @self by API functions calls.

Returns

a #JSCException or None if there isn’t any unhandled exception in the #JSCContext.

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

Get a #JSCValue referencing the @self global object

Returns

a #JSCValue

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

Get a property of @self global object with @name.

name

the value name

Returns

a #JSCValue

pub fn virtual_machine(&self) -> Option<VirtualMachine>

Get the #JSCVirtualMachine where @self was created.

Returns

the #JSCVirtualMachine where the #JSCContext was created.

pub fn pop_exception_handler(&self)

Remove the last #JSCExceptionHandler previously pushed to @self with jsc_context_push_exception_handler().

pub fn push_exception_handler<P: Fn(&Context, &Exception) + 'static>( &self, handler: P, )

Push an exception handler in @self. Whenever a JavaScript exception happens in the #JSCContext, the given @handler will be called. The default #JSCExceptionHandler simply calls jsc_context_throw_exception() to throw the exception to the #JSCContext. If you don’t want to catch the exception, but only get notified about it, call jsc_context_throw_exception() in @handler like the default one does. The last exception handler pushed is the only one used by the #JSCContext, use jsc_context_pop_exception_handler() to remove it and set the previous one. When @handler is removed from the context, @destroy_notify i called with @user_data as parameter.

handler

a #JSCExceptionHandler

destroy_notify

destroy notifier for @user_data

pub fn set_value(&self, name: &str, value: &Value)

Set a property of @self global object with @name and @value.

name

the value name

value

a #JSCValue

pub fn throw(&self, error_message: &str)

Throw an exception to @self using the given error message. The created #JSCException can be retrieved with jsc_context_get_exception().

error_message

an error message

pub fn throw_exception(&self, exception: &Exception)

Throw @exception to @self.

exception

a #JSCException

pub fn throw_with_name(&self, error_name: &str, error_message: &str)

Throw an exception to @self using the given error name and message. The created #JSCException can be retrieved with jsc_context_get_exception().

error_name

the error name

error_message

an error message

pub fn current() -> Option<Context>

Get the #JSCContext that is currently executing a function. This should only be called within a function or method callback, otherwise None will be returned.

Returns

the #JSCContext that is currently executing.

Trait Implementations

impl Clone for Context

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 Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Context

type ParamSpec = ParamSpecObject

type SetValue = Context

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Context

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 Context

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 Context

type Parent = Object

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

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 Context

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 Context

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Context