Struct boa_engine::object::builtins::JsRegExp

pub struct JsRegExp { /* private fields */ }

JsRegExp provides a wrapper for Boa’s implementation of the ECMAScript RegExp builtin object

Examples

Create a JsRegExp and run RegExp.prototype.test( String )

// Initialize the `Context`
let context = &mut Context::default();

// Create a new RegExp with pattern and flags
let regexp = JsRegExp::new("foo", "gi", context)?;

let test_result = regexp.test("football", context)?;
assert!(test_result);

let to_string = regexp.to_string(context)?;
assert_eq!(to_string, String::from("/foo/gi"));

Implementations

impl JsRegExp

pub fn new<S>(pattern: S, flags: S, context: &mut Context<'_>) -> JsResult<Self>where S: Into<JsValue>,

Create a new JsRegExp object

// Initialize the `Context`
let context = &mut Context::default();

// Create a new RegExp with pattern and flags
let regexp = JsRegExp::new("foo", "gi", context)?;

pub fn from_object(object: JsObject) -> JsResult<Self>

Create a JsRegExp from a regular expression JsObject

pub fn has_indices(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the d flag is present in JsRegExp flags

pub fn global(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the g flag is present in JsRegExp flags

pub fn ignore_case(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the i flag is present in JsRegExp flags

pub fn multiline(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the m flag is present in JsRegExp flags

pub fn dot_all(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the s flag is present in JsRegExp flags

pub fn unicode(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the u flag is present in JsRegExp flags

pub fn sticky(&self, context: &mut Context<'_>) -> JsResult<bool>

Returns a boolean value for whether the y flag is present in JsRegExp flags

pub fn flags(&self, context: &mut Context<'_>) -> JsResult<String>

Returns the flags of JsRegExp as a string

let regexp = JsRegExp::new("foo", "gi", context)?;

let flags = regexp.flags(context)?;
assert_eq!(flags, String::from("gi"));

pub fn source(&self, context: &mut Context<'_>) -> JsResult<String>

Returns the source pattern of JsRegExp as a string

let regexp = JsRegExp::new("foo", "gi", context)?;

let src = regexp.source(context)?;
assert_eq!(src, String::from("foo"));

pub fn test<S>( &self, search_string: S, context: &mut Context<'_> ) -> JsResult<bool>where S: Into<JsValue>,

Executes a search for a match between JsRegExp and the provided string

let regexp = JsRegExp::new("foo", "gi", context)?;

let test_result = regexp.test("football", context)?;
assert!(test_result);

pub fn exec<S>( &self, search_string: S, context: &mut Context<'_> ) -> JsResult<Option<JsArray>>where S: Into<JsValue>,

Executes a search for a match in a specified string

Returns a JsArray containing matched value and updates the lastIndex property, or None

pub fn to_string(&self, context: &mut Context<'_>) -> JsResult<String>

Return a string representing the regular expression.

let regexp = JsRegExp::new("foo", "gi", context)?;

let to_string = regexp.to_string(context)?;
assert_eq!(to_string, String::from("/foo/gi"));

Methods from Deref<Target = JsObject>

pub fn borrow(&self) -> Ref<'_, Object>

Immutably borrows the Object.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

Panics

Panics if the object is currently mutably borrowed.

pub fn borrow_mut(&self) -> RefMut<'_, Object, Object>

Mutably borrows the Object.

The borrow lasts until the returned RefMut exits scope. The object cannot be borrowed while this borrow is active.

Panics

Panics if the object is currently borrowed.

pub fn try_borrow(&self) -> StdResult<Ref<'_, Object>, BorrowError>

Immutably borrows the Object, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned GcCellRef exits scope. Multiple immutable borrows can be taken out at the same time.

This is the non-panicking variant of borrow.

pub fn try_borrow_mut( &self ) -> StdResult<RefMut<'_, Object, Object>, BorrowMutError>

Mutably borrows the object, returning an error if the value is currently borrowed.

The borrow lasts until the returned GcCellRefMut exits scope. The object be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

pub fn is<T>(&self) -> boolwhere T: NativeObject,

Return true if it is a native object and the native type is T.

Panics

Panics if the object is currently mutably borrowed.

pub fn downcast_ref<T>(&self) -> Option<Ref<'_, T>>where T: NativeObject,

Downcast a reference to the object, if the object is type native object type T.

Panics

Panics if the object is currently mutably borrowed.

pub fn downcast_mut<T>(&self) -> Option<RefMut<'_, Object, T>>where T: NativeObject,

Downcast a mutable reference to the object, if the object is type native object type T.

Panics

Panics if the object is currently borrowed.

pub fn prototype(&self) -> JsPrototype

Get the prototype of the object.

Panics

Panics if the object is currently mutably borrowed.

pub fn set_prototype(&self, prototype: JsPrototype) -> bool

Set the prototype of the object.

Panics

Panics if the object is currently mutably borrowed

pub fn is_array(&self) -> bool

Checks if it’s an Array object.

pub fn is_data_view(&self) -> bool

Checks if it’s a DataView object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_array_iterator(&self) -> bool

Checks if it is an ArrayIterator object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_array_buffer(&self) -> bool

Checks if it’s an ArrayBuffer object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_map(&self) -> bool

Checks if it is a Map object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_map_iterator(&self) -> bool

Checks if it’s a MapIterator object

Panics

Panics if the object is currently mutably borrowed.

pub fn is_set(&self) -> bool

Checks if it is a Set object

Panics

Panics if the object is currently mutably borrowed.

pub fn is_set_iterator(&self) -> bool

Checks if it is a SetIterator object

Panics

Panics if the object is currently mutably borrowed.

pub fn is_string(&self) -> bool

Checks if it’s a String object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_function(&self) -> bool

Checks if it’s a Function object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_generator(&self) -> bool

Checks if it’s a Generator object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_symbol(&self) -> bool

Checks if it’s a Symbol object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_error(&self) -> bool

Checks if it’s an Error object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_boolean(&self) -> bool

Checks if it’s a Boolean object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_number(&self) -> bool

Checks if it’s a Number object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_bigint(&self) -> bool

Checks if it’s a BigInt object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_date(&self) -> bool

Checks if it’s a Date object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_regexp(&self) -> bool

Checks if it’s a RegExp object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_array(&self) -> bool

Checks if it’s a TypedArray object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_uint8_array(&self) -> bool

Checks if it’s a Uint8Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_int8_array(&self) -> bool

Checks if it’s a Int8Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_uint16_array(&self) -> bool

Checks if it’s a Uint16Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_int16_array(&self) -> bool

Checks if it’s a Int16Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_uint32_array(&self) -> bool

Checks if it’s a Uint32Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_int32_array(&self) -> bool

Checks if it’s a Int32Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_float32_array(&self) -> bool

Checks if it’s a Float32Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_float64_array(&self) -> bool

Checks if it’s a Float64Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_promise(&self) -> bool

Checks if it’s a Promise object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_ordinary(&self) -> bool

Checks if it’s an ordinary object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_proxy(&self) -> bool

Checks if it’s a proxy object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_native_object(&self) -> bool

Returns true if it holds an Rust type that implements NativeObject.

Panics

Panics if the object is currently mutably borrowed.

pub fn to_property_descriptor( &self, context: &mut Context<'_> ) -> JsResult<PropertyDescriptor>

The abstract operation ToPropertyDescriptor.

More information:

• ECMAScript reference

pub fn copy_data_properties<K>( &self, source: &JsValue, excluded_keys: Vec<K>, context: &mut Context<'_> ) -> JsResult<()>where K: Into<PropertyKey>,

7.3.25 CopyDataProperties ( target, source, excludedItems )

More information:

• ECMAScript

pub fn insert_property<K, P>(&self, key: K, property: P) -> boolwhere K: Into<PropertyKey>, P: Into<PropertyDescriptor>,

Inserts a field in the object properties without checking if it’s writable.

If a field was already in the object with the same name, than true is returned with that field, otherwise false is returned.

pub fn is_callable(&self) -> bool

It determines if Object is a callable function with a [[Call]] internal method.

More information:

• ECMAScript reference

pub fn is_constructor(&self) -> bool

It determines if Object is a function object with a [[Construct]] internal method.

More information:

• ECMAScript reference

pub fn is_global(&self) -> bool

Returns true if the JsObject is the global for a Realm

pub fn is_extensible(&self, context: &mut Context<'_>) -> JsResult<bool>

Check if object is extensible.

More information:

• ECMAScript reference

pub fn get<K>(&self, key: K, context: &mut Context<'_>) -> JsResult<JsValue>where K: Into<PropertyKey>,

Get property from object or throw.

More information:

• ECMAScript reference

pub fn set<K, V>( &self, key: K, value: V, throw: bool, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>, V: Into<JsValue>,

set property of object or throw if bool flag is passed.

More information:

• ECMAScript reference

pub fn create_data_property<K, V>( &self, key: K, value: V, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>, V: Into<JsValue>,

Create data property

More information:

• ECMAScript reference

pub fn create_data_property_or_throw<K, V>( &self, key: K, value: V, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>, V: Into<JsValue>,

Create data property or throw

More information:

• ECMAScript reference

pub fn define_property_or_throw<K, P>( &self, key: K, desc: P, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>, P: Into<PropertyDescriptor>,

Define property or throw.

More information:

• ECMAScript reference

pub fn delete_property_or_throw<K>( &self, key: K, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>,

Defines the property or throws a TypeError if the operation fails.

More information:

• ECMAScript reference

pub fn has_property<K>( &self, key: K, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>,

Check if object has property.

More information:

• ECMAScript reference

pub fn has_own_property<K>( &self, key: K, context: &mut Context<'_> ) -> JsResult<bool>where K: Into<PropertyKey>,

Check if object has an own property.

More information:

• ECMAScript reference

pub fn call( &self, this: &JsValue, args: &[JsValue], context: &mut Context<'_> ) -> JsResult<JsValue>

Call ( F, V [ , argumentsList ] )

Panics

Panics if the object is currently mutably borrowed.

More information:

• ECMAScript reference

pub fn construct( &self, args: &[JsValue], new_target: Option<&Self>, context: &mut Context<'_> ) -> JsResult<Self>

Construct ( F [ , argumentsList [ , newTarget ] ] )

Construct an instance of this object with the specified arguments.

Panics

Panics if the object is currently mutably borrowed.

More information:

• ECMAScript reference

pub fn set_integrity_level( &self, level: IntegrityLevel, context: &mut Context<'_> ) -> JsResult<bool>

Make the object sealed or frozen.

More information:

• ECMAScript reference

pub fn test_integrity_level( &self, level: IntegrityLevel, context: &mut Context<'_> ) -> JsResult<bool>

Check if the object is sealed or frozen.

More information:

• ECMAScript reference

Trait Implementations

impl Clone for JsRegExp

fn clone(&self) -> JsRegExp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsRegExp

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

Formats the value using the given formatter.

impl Deref for JsRegExp

type Target = JsObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for JsRegExp

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for JsRegExp

fn finalize(&self)

Cleanup logic for a type.

impl From<JsRegExp> for JsObject

fn from(o: JsRegExp) -> Self

Converts to this type from the input type.

impl From<JsRegExp> for JsValue

fn from(o: JsRegExp) -> Self

Converts to this type from the input type.

impl Trace for JsRegExp

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn root(&self)

Increments the root-count of all contained Gcs.

unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs.

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.

impl TryFromJs for JsRegExp

fn try_from_js(value: &JsValue, _context: &mut Context<'_>) -> JsResult<Self>

This function tries to convert a JavaScript value into Self.