js_sys

Struct RegExp

source
pub struct RegExp { /* private fields */ }

Implementations§

source§

impl RegExp

source

pub fn exec(&self, text: &str) -> Option<Array>

The exec() method executes a search for a match in a specified string. Returns a result array, or null.

MDN documentation

source§

impl RegExp

source

pub fn flags(&self) -> JsString

The flags property returns a string consisting of the flags of the current regular expression object.

MDN documentation

source§

impl RegExp

source

pub fn global(&self) -> bool

The global property indicates whether or not the “g” flag is used with the regular expression. global is a read-only property of an individual regular expression instance.

MDN documentation

source§

impl RegExp

source

pub fn ignore_case(&self) -> bool

The ignoreCase property indicates whether or not the “i” flag is used with the regular expression. ignoreCase is a read-only property of an individual regular expression instance.

MDN documentation

source§

impl RegExp

source

pub fn input() -> JsString

The non-standard input property is a static property of regular expressions that contains the string against which a regular expression is matched. RegExp.$_ is an alias for this property.

MDN documentation

source§

impl RegExp

source

pub fn last_index(&self) -> u32

The lastIndex is a read/write integer property of regular expression instances that specifies the index at which to start the next match.

MDN documentation

source§

impl RegExp

source

pub fn set_last_index(&self, index: u32)

The lastIndex is a read/write integer property of regular expression instances that specifies the index at which to start the next match.

MDN documentation

source§

impl RegExp

source

pub fn last_match() -> JsString

The non-standard lastMatch property is a static and read-only property of regular expressions that contains the last matched characters. RegExp.$& is an alias for this property.

MDN documentation

source§

impl RegExp

source

pub fn last_paren() -> JsString

The non-standard lastParen property is a static and read-only property of regular expressions that contains the last parenthesized substring match, if any. RegExp.$+ is an alias for this property.

MDN documentation

source§

impl RegExp

source

pub fn left_context() -> JsString

The non-standard leftContext property is a static and read-only property of regular expressions that contains the substring preceding the most recent match. `RegExp.$`` is an alias for this property.

MDN documentation

source§

impl RegExp

source

pub fn multiline(&self) -> bool

The multiline property indicates whether or not the “m” flag is used with the regular expression. multiline is a read-only property of an individual regular expression instance.

MDN documentation

source§

impl RegExp

source

pub fn n1() -> JsString

The non-standard $1, $2, $3, $4, $5, $6, $7, $8, $9 properties are static and read-only properties of regular expressions that contain parenthesized substring matches.

MDN documentation

source§

impl RegExp

source

pub fn n2() -> JsString

source§

impl RegExp

source

pub fn n3() -> JsString

source§

impl RegExp

source

pub fn n4() -> JsString

source§

impl RegExp

source

pub fn n5() -> JsString

source§

impl RegExp

source

pub fn n6() -> JsString

source§

impl RegExp

source

pub fn n7() -> JsString

source§

impl RegExp

source

pub fn n8() -> JsString

source§

impl RegExp

source

pub fn n9() -> JsString

source§

impl RegExp

source

pub fn new(pattern: &str, flags: &str) -> RegExp

The RegExp constructor creates a regular expression object for matching text with a pattern.

MDN documentation

source§

impl RegExp

source

pub fn new_regexp(pattern: &RegExp, flags: &str) -> RegExp

source§

impl RegExp

source

pub fn right_context() -> JsString

The non-standard rightContext property is a static and read-only property of regular expressions that contains the substring following the most recent match. RegExp.$' is an alias for this property.

MDN documentation

source§

impl RegExp

source

pub fn source(&self) -> JsString

The source property returns a String containing the source text of the regexp object, and it doesn’t contain the two forward slashes on both sides and any flags.

MDN documentation

source§

impl RegExp

source

pub fn sticky(&self) -> bool

The sticky property reflects whether or not the search is sticky (searches in strings only from the index indicated by the lastIndex property of this regular expression). sticky is a read-only property of an individual regular expression object.

MDN documentation

source§

impl RegExp

source

pub fn test(&self, text: &str) -> bool

The test() method executes a search for a match between a regular expression and a specified string. Returns true or false.

MDN documentation

source§

impl RegExp

source

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the regular expression.

MDN documentation

source§

impl RegExp

source

pub fn unicode(&self) -> bool

The unicode property indicates whether or not the “u” flag is used with a regular expression. unicode is a read-only property of an individual regular expression instance.

MDN documentation

Methods from Deref<Target = Object>§

source

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

source

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

source

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

source

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

source

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

source

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

source

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>§

source

pub const NULL: JsValue = _

source

pub const UNDEFINED: JsValue = _

source

pub const TRUE: JsValue = _

source

pub const FALSE: JsValue = _

source

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

source

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

source

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

§UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

source

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

source

pub fn is_null(&self) -> bool

Tests whether this JS value is null

source

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

source

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

source

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

source

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

source

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

source

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

source

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

source

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

source

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

source

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

source

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

source

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

source

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

source

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

source

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

source

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

source

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

source

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

source

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

source

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations§

source§

impl AsRef<JsValue> for RegExp

source§

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Object> for RegExp

source§

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<RegExp> for RegExp

source§

fn as_ref(&self) -> &RegExp

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Clone for RegExp

source§

fn clone(&self) -> RegExp

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RegExp

source§

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

Formats the value using the given formatter. Read more
source§

impl Deref for RegExp

source§

type Target = Object

The resulting type after dereferencing.
source§

fn deref(&self) -> &Object

Dereferences the value.
source§

impl From<JsValue> for RegExp

source§

fn from(obj: JsValue) -> RegExp

Converts to this type from the input type.
source§

impl From<RegExp> for JsValue

source§

fn from(obj: RegExp) -> JsValue

Converts to this type from the input type.
source§

impl From<RegExp> for Object

source§

fn from(obj: RegExp) -> Object

Converts to this type from the input type.
source§

impl FromWasmAbi for RegExp

source§

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
source§

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi. Read more
source§

impl<'a> IntoWasmAbi for &'a RegExp

source§

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.
source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
source§

impl IntoWasmAbi for RegExp

source§

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.
source§

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
source§

impl JsCast for RegExp

source§

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type. Read more
source§

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self Read more
source§

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self. Read more
source§

fn has_type<T>(&self) -> bool
where T: JsCast,

Test whether this JS value has a type T. Read more
source§

fn dyn_into<T>(self) -> Result<T, Self>
where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T. Read more
source§

fn dyn_ref<T>(&self) -> Option<&T>
where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T. Read more
source§

fn unchecked_into<T>(self) -> T
where T: JsCast,

Performs a zero-cost unchecked cast into the specified type. Read more
source§

fn unchecked_ref<T>(&self) -> &T
where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type. Read more
source§

fn is_instance_of<T>(&self) -> bool
where T: JsCast,

Test whether this JS value is an instance of the type T. Read more
source§

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type. Read more
source§

impl LongRefFromWasmAbi for RegExp

source§

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi
source§

type Anchor = RegExp

Same as RefFromWasmAbi::Anchor
source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
source§

impl OptionFromWasmAbi for RegExp

source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
source§

impl<'a> OptionIntoWasmAbi for &'a RegExp

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl OptionIntoWasmAbi for RegExp

source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
source§

impl PartialEq for RegExp

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl RefFromWasmAbi for RegExp

source§

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.
source§

type Anchor = ManuallyDrop<RegExp>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
source§

impl WasmDescribe for RegExp

source§

impl Eq for RegExp

source§

impl StructuralPartialEq for RegExp

Auto Trait Implementations§

§

impl Freeze for RegExp

§

impl RefUnwindSafe for RegExp

§

impl !Send for RegExp

§

impl !Sync for RegExp

§

impl Unpin for RegExp

§

impl UnwindSafe for RegExp

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ReturnWasmAbi for T
where T: IntoWasmAbi,

source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> VectorFromWasmAbi for T
where T: JsObject,

source§

impl<T> VectorIntoWasmAbi for T
where T: JsObject,