Struct JsString 

pub struct JsString { /* private fields */ }

Implementations

impl JsString

pub fn length(&self) -> u32

impl JsString

pub fn at(&self, index: i32) -> Option<JsString>

impl JsString

pub fn char_at(&self, index: u32) -> JsString

impl JsString

pub fn char_code_at(&self, index: u32) -> f64

impl JsString

pub fn code_point_at(&self, pos: u32) -> JsValue

impl JsString

pub fn try_code_point_at(&self, pos: u32) -> Option<u16>

impl JsString

pub fn concat(&self, string_2: &JsValue) -> JsString

impl JsString

pub fn concat_many(&self, strings: &[JsString]) -> JsString

impl JsString

pub fn ends_with(&self, search_string: &str, length: i32) -> bool

impl JsString

pub fn from_char_code(char_codes: &[u16]) -> JsString

impl JsString

pub fn from_char_code1(a: u32) -> JsString

impl JsString

pub fn from_char_code2(a: u32, b: u32) -> JsString

impl JsString

pub fn from_char_code3(a: u32, b: u32, c: u32) -> JsString

impl JsString

pub fn from_char_code4(a: u32, b: u32, c: u32, d: u32) -> JsString

impl JsString

pub fn from_char_code5(a: u32, b: u32, c: u32, d: u32, e: u32) -> JsString

impl JsString

pub fn from_code_point(code_points: &[u32]) -> Result<JsString, JsValue>

impl JsString

pub fn from_code_point1(a: u32) -> Result<JsString, JsValue>

impl JsString

pub fn from_code_point2(a: u32, b: u32) -> Result<JsString, JsValue>

impl JsString

pub fn from_code_point3(a: u32, b: u32, c: u32) -> Result<JsString, JsValue>

impl JsString

pub fn from_code_point4( a: u32, b: u32, c: u32, d: u32, ) -> Result<JsString, JsValue>

impl JsString

pub fn from_code_point5( a: u32, b: u32, c: u32, d: u32, e: u32, ) -> Result<JsString, JsValue>

impl JsString

pub fn includes(&self, search_string: &str, position: i32) -> bool

impl JsString

pub fn index_of(&self, search_value: &str, from_index: i32) -> i32

impl JsString

pub fn last_index_of(&self, search_value: &str, from_index: i32) -> i32

impl JsString

pub fn locale_compare( &self, compare_string: &str, locales: &Array, options: &Object, ) -> i32

impl JsString

pub fn match_(&self, pattern: &RegExp) -> Option<Object>

impl JsString

pub fn match_all(&self, pattern: &RegExp) -> Iterator

impl JsString

pub fn normalize(&self, form: &str) -> JsString

impl JsString

pub fn pad_end(&self, target_length: u32, pad_string: &str) -> JsString

impl JsString

pub fn pad_start(&self, target_length: u32, pad_string: &str) -> JsString

impl JsString

pub fn repeat(&self, count: i32) -> JsString

impl JsString

pub fn replace(&self, pattern: &str, replacement: &str) -> JsString

impl JsString

pub fn replace_with_function( &self, pattern: &str, replacement: &Function, ) -> JsString

impl JsString

pub fn replace_by_pattern( &self, pattern: &RegExp, replacement: &str, ) -> JsString

impl JsString

pub fn replace_by_pattern_with_function( &self, pattern: &RegExp, replacement: &Function, ) -> JsString

impl JsString

pub fn replace_all(&self, pattern: &str, replacement: &str) -> JsString

impl JsString

pub fn replace_all_with_function( &self, pattern: &str, replacement: &Function, ) -> JsString

impl JsString

pub fn replace_all_by_pattern( &self, pattern: &RegExp, replacement: &str, ) -> JsString

impl JsString

pub fn replace_all_by_pattern_with_function( &self, pattern: &RegExp, replacement: &Function, ) -> JsString

impl JsString

pub fn search(&self, pattern: &RegExp) -> i32

impl JsString

pub fn slice(&self, start: u32, end: u32) -> JsString

impl JsString

pub fn split(&self, separator: &str) -> Array

impl JsString

pub fn split_limit(&self, separator: &str, limit: u32) -> Array

impl JsString

pub fn split_by_pattern(&self, pattern: &RegExp) -> Array

impl JsString

pub fn split_by_pattern_limit(&self, pattern: &RegExp, limit: u32) -> Array

impl JsString

pub fn starts_with(&self, search_string: &str, position: u32) -> bool

impl JsString

pub fn substring(&self, index_start: u32, index_end: u32) -> JsString

impl JsString

pub fn substr(&self, start: i32, length: i32) -> JsString

impl JsString

pub fn to_locale_lower_case(&self, locale: Option<&str>) -> JsString

impl JsString

pub fn to_locale_upper_case(&self, locale: Option<&str>) -> JsString

impl JsString

pub fn to_lower_case(&self) -> JsString

impl JsString

pub fn to_string(&self) -> JsString

impl JsString

pub fn to_upper_case(&self) -> JsString

impl JsString

pub fn trim(&self) -> JsString

impl JsString

pub fn trim_end(&self) -> JsString

impl JsString

pub fn trim_right(&self) -> JsString

impl JsString

pub fn trim_start(&self) -> JsString

impl JsString

pub fn trim_left(&self) -> JsString

impl JsString

pub fn value_of(&self) -> JsString

impl JsString

pub fn raw( call_site: &Object, substitutions: &Array, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_0(call_site: &Object) -> Result<JsString, JsValue>

impl JsString

pub fn raw_1( call_site: &Object, substitutions_1: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_2( call_site: &Object, substitutions1: &str, substitutions2: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_3( call_site: &Object, substitutions1: &str, substitutions2: &str, substitutions3: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_4( call_site: &Object, substitutions1: &str, substitutions2: &str, substitutions3: &str, substitutions4: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_5( call_site: &Object, substitutions1: &str, substitutions2: &str, substitutions3: &str, substitutions4: &str, substitutions5: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_6( call_site: &Object, substitutions1: &str, substitutions2: &str, substitutions3: &str, substitutions4: &str, substitutions5: &str, substitutions6: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn raw_7( call_site: &Object, substitutions1: &str, substitutions2: &str, substitutions3: &str, substitutions4: &str, substitutions5: &str, substitutions6: &str, substitutions7: &str, ) -> Result<JsString, JsValue>

impl JsString

pub fn try_from(val: &JsValue) -> Option<&JsString>

👎Deprecated:

recommended to use dyn_ref instead which is now equivalent

Returns the JsString value of this JS value if it’s an instance of a string.

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

pub fn is_valid_utf16(&self) -> bool

Returns whether this string is a valid UTF-16 string.

This is useful for learning whether String::from(..) will return a lossless representation of the JS string. If this string contains unpaired surrogates then String::from will succeed but it will be a lossy representation of the JS string because unpaired surrogates will become replacement characters.

If this function returns false then to get a lossless representation of the string you’ll need to manually use the iter method (or the char_code_at accessor) to view the raw character codes.

For more information, see the documentation on JS strings vs Rust strings

pub fn iter( &self, ) -> impl ExactSizeIterator<Item = u16> + DoubleEndedIterator<Item = u16> + '_

Returns an iterator over the u16 character codes that make up this JS string.

This method will call char_code_at for each code in this JS string, returning an iterator of the codes in sequence.

pub fn as_char(&self) -> Option<char>

If this string consists of a single Unicode code point, then this method converts it into a Rust char without doing any allocations.

If this JS value is not a valid UTF-8 or consists of more than a single codepoint, then this returns None.

Note that a single Unicode code point might be represented as more than one code unit on the JavaScript side. For example, a JavaScript string "\uD801\uDC37" is actually a single Unicode code point U+10437 which corresponds to a character ‘𐐷’.

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

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

👎Deprecated:

Use Object::hasOwn instead.

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

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

pub fn to_locale_string(&self) -> JsString

pub fn to_string(&self) -> JsString

pub fn to_js_string(&self) -> JsString

pub fn value_of(&self) -> Object

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn unchecked_into_f64(&self) -> f64

Returns the value as f64 without type checking. Used by serde-wasm-bindgen for numeric conversions.

pub fn has_type<T>(&self) -> bool

where T: JsCast,

Check if this value is an instance of a specific JS type.

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

Checked division.

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

Power operation.

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

Bitwise AND.

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

Bitwise OR.

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

Bitwise XOR.

pub fn bit_not(&self) -> JsValue

Bitwise NOT.

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

Left shift.

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

Signed right shift.

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

Unsigned right shift.

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

Add.

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

Subtract.

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

Multiply.

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

Divide.

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

Remainder.

pub fn neg(&self) -> JsValue

Negate.

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

Less than comparison.

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

Less than or equal comparison.

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

Greater than comparison.

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

Greater than or equal comparison.

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

Loose equality (==).

pub fn is_falsy(&self) -> bool

Check if this value is a falsy value in JavaScript.

pub fn is_truthy(&self) -> bool

Check if this value is a truthy value in JavaScript.

pub fn is_object(&self) -> bool

Check if this value is an object.

pub fn is_function(&self) -> bool

Check if this value is a function.

pub fn is_string(&self) -> bool

Check if this value is a string.

pub fn is_symbol(&self) -> bool

Check if this value is a symbol.

pub fn is_bigint(&self) -> bool

Check if this value is a bigint.

pub fn is_array(&self) -> bool

Check if this value is an Array.

pub fn is_undefined(&self) -> bool

Check if this value is undefined.

pub fn is_null(&self) -> bool

Check if this value is null.

pub fn is_null_or_undefined(&self) -> bool

Check if this value is null or undefined.

pub fn js_typeof(&self) -> JsValue

Get the typeof this value as a string.

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

Check if this value has a property with the given name.

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

Get the value as a bool.

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

Get the value as an f64.

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

Get the value as a string.

pub fn as_debug_string(&self) -> String

Get a debug string representation of the value.

Trait Implementations

impl AsRef<JsString> for JsString

fn as_ref(&self) -> &JsString

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

impl AsRef<JsValue> for JsString

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for JsString

fn as_ref(&self) -> &Object

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

impl BatchableResult for JsString

fn try_placeholder(batch: &mut Runtime<'_>) -> Option<Self>

impl BinaryDecode for JsString

fn decode(decoder: &mut DecodedData<'_>) -> Result<Self, DecodeError>

impl BinaryEncode for JsString

fn encode(self, encoder: &mut EncodedData)

impl Clone for JsString

fn clone(&self) -> JsString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsString

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

Formats the value using the given formatter.

impl Default for JsString

fn default() -> Self

Returns the “default value” for a type.

impl Deref for JsString

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl Display for JsString

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

Formats the value using the given formatter.

impl EncodeTypeDef for JsString

fn encode_type_def(type_def: &mut TypeDef)

impl Eq for JsString

impl ErasableGeneric for JsString

type Repr = JsValue

impl<'a> From<&'a JsString> for String

fn from(s: &'a JsString) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for JsString

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<JsString> for JsValue

fn from(val: JsString) -> Self

Converts to this type from the input type.

impl From<JsString> for Object

fn from(val: JsString) -> Object

Converts to this type from the input type.

impl From<JsString> for String

fn from(s: JsString) -> Self

Converts to this type from the input type.

impl From<JsValue> for JsString

fn from(val: JsValue) -> Self

Converts to this type from the input type.

impl From<String> for JsString

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<char> for JsString

fn from(c: char) -> Self

Converts to this type from the input type.

impl FromStr for JsString

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl IntoJsGeneric for JsString

where JsString: JsGeneric,

type JsCanon = JsString

fn to_js(self) -> Self::JsCanon

impl JsCast for JsString

fn instanceof(__val: &JsValue) -> bool

Check if a JsValue is an instance of this type.

fn is_type_of(__val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> Self

Unchecked cast from JsValue to this type.

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

Unchecked cast from a JsValue reference to a reference of this type.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

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

where T: JsCast,

Try to cast this value to type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Try to get a reference to type T from this value.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Unchecked cast to another type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Unchecked cast to a reference of another type.

impl JsRefEncode for JsString

fn js_ref(&self) -> JsRef

impl Ord for JsString

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

This method returns an Ordering between self and other.

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,

Restrict a value to a certain interval.

impl PartialEq for JsString

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialEq<&'a String> for JsString

fn eq(&self, other: &&'a String) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialEq<&'a str> for JsString

fn eq(&self, other: &&'a str) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<String> for JsString

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for JsString

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for JsString

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

Tests greater than (for self and other) and is used by the > operator.

impl Promising for JsString

type Resolution = JsString

impl StructuralPartialEq for JsString

impl UpcastFrom<&str> for JsString

impl UpcastFrom<JsString> for JsValue

impl UpcastFrom<JsString> for JsOption<JsValue>

impl UpcastFrom<JsString> for JsString

impl UpcastFrom<JsString> for JsOption<JsString>

impl UpcastFrom<JsString> for Object

impl UpcastFrom<JsString> for JsOption<Object>

impl UpcastFrom<JsString> for String

impl UpcastFrom<JsString> for &str

impl UpcastFrom<JsString> for char

impl UpcastFrom<String> for JsString

impl UpcastFrom<char> for JsString