Trait javascriptcore::prelude::ContextExt

pub trait ContextExt: 'static {
    fn check_syntax(
        &self,
        code: &str,
        mode: CheckSyntaxMode,
        uri: &str,
        line_number: u32
    ) -> (CheckSyntaxResult, Exception);
    fn clear_exception(&self);
    fn evaluate(&self, code: &str) -> Option<Value>;
    fn evaluate_with_source_uri(
        &self,
        code: &str,
        uri: &str,
        line_number: u32
    ) -> Option<Value>;
    fn exception(&self) -> Option<Exception>;
    fn global_object(&self) -> Option<Value>;
    fn value(&self, name: &str) -> Option<Value>;
    fn virtual_machine(&self) -> Option<VirtualMachine>;
    fn pop_exception_handler(&self);
    fn push_exception_handler<P: Fn(&Context, &Exception) + 'static>(
        &self,
        handler: P
    );
    fn set_value(&self, name: &str, value: &impl IsA<Value>);
    fn throw(&self, error_message: &str);
    fn throw_exception(&self, exception: &impl IsA<Exception>);
    fn throw_with_name(&self, error_name: &str, error_message: &str);
}

Trait containing all Context methods.

Implementors

Context

Required Methods

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 Exception 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 CheckSyntaxMode

uri

the source URI

line_number

the starting line number

Returns

a CheckSyntaxResult

exception

return location for a Exception, or None to ignore

fn clear_exception(&self)

Clear the uncaught exception in self if any.

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 Value representing the last value generated by the script.

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 Value representing the last value generated by the script.

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

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

Returns

a Exception or None if there isn’t any unhandled exception in the Context.

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

Get a Value referencing the self global object

Returns

a Value

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

Get a property of self global object with name.

name

the value name

Returns

a Value

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

Get the VirtualMachine where self was created.

Returns

the VirtualMachine where the Context was created.

fn pop_exception_handler(&self)

Remove the last JSCExceptionHandler previously pushed to self with push_exception_handler().

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 Context, the given handler will be called. The default JSCExceptionHandler simply calls throw_exception() to throw the exception to the Context. If you don’t want to catch the exception, but only get notified about it, call throw_exception() in handler like the default one does. The last exception handler pushed is the only one used by the Context, use 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

fn set_value(&self, name: &str, value: &impl IsA<Value>)

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

name

the value name

value

a Value

fn throw(&self, error_message: &str)

Throw an exception to self using the given error message. The created Exception can be retrieved with exception().

error_message

an error message

fn throw_exception(&self, exception: &impl IsA<Exception>)

Throw exception to self.

exception

a Exception

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 Exception can be retrieved with exception().

error_name

the error name

error_message

an error message

Implementors

impl<O: IsA<Context>> ContextExt for O