Struct JsStr 

pub struct JsStr<'a> { /* private fields */ }

This is equivalent to Rust’s &str.

Implementations

impl<'a> JsStr<'a>

pub const EMPTY: Self

This represents an empty string.

pub const fn latin1(value: &'a [u8]) -> Self

Creates a JsStr from codepoints that can fit in a u8.

pub const fn utf16(value: &'a [u16]) -> Self

Creates a JsStr from utf16 encoded string.

pub const fn len(&self) -> usize

Get the length of the JsStr.

pub const fn variant(self) -> JsStrVariant<'a>

Return the inner JsStrVariant varient of the JsStr.

pub const fn is_latin1(&self) -> bool

Check if the JsStr is latin1 encoded.

pub const fn as_latin1(&self) -> Option<&[u8]>

Returns u8 slice if the JsStr is latin1 encoded, otherwise None.

pub fn iter(self) -> Iter<'a>

Iterate over the codepoints of the string.

pub fn windows(self, size: usize) -> Windows<'a>

Iterate over the codepoints of the string.

pub fn is_empty(&self) -> bool

Check if the JsStr is empty.

pub fn trim(self) -> JsStr<'a>

Trims both leading and trailing space.

pub fn trim_start(self) -> Self

Trims all leading space.

pub fn trim_end(self) -> Self

Trims all trailing space.

pub fn get<I>(self, index: I) -> Option<I::Value>

where I: JsSliceIndex<'a>,

Returns an element or subslice depending on the type of index, otherwise None.

pub fn get_expect<I>(&self, index: I) -> I::Value

where I: JsSliceIndex<'a>,

Get the element at the given index.

Panics

If the index is out of bounds.

pub unsafe fn get_unchecked<I>(self, index: I) -> I::Value

where I: JsSliceIndex<'a>,

Returns an element or subslice depending on the type of index, without doing bounds check.

Safety

Caller must ensure the index is not out of bounds

pub fn to_vec(&self) -> Vec<u16>

Convert the JsStr into a Vec<U16>.

pub fn starts_with(&self, needle: JsStr<'_>) -> bool

Returns true if needle is a prefix of the JsStr.

pub fn ends_with(&self, needle: JsStr<'_>) -> bool

Returns true if needle is a suffix of the JsStr.

pub fn index_of( &self, search_value: JsStr<'_>, from_index: usize, ) -> Option<usize>

Abstract operation StringIndexOf ( string, searchValue, fromIndex )

Note: Instead of returning an isize with -1 as the “not found” value, we make use of the type system and return Option<usize> with None as the “not found” value.

More information:

• ECMAScript reference

pub fn code_point_at(&self, position: usize) -> CodePoint

Abstract operation CodePointAt( string, position ).

The abstract operation CodePointAt takes arguments string (a String) and position (a non-negative integer) and returns a Record with fields [[CodePoint]] (a code point), [[CodeUnitCount]] (a positive integer), and [[IsUnpairedSurrogate]] (a Boolean). It interprets string as a sequence of UTF-16 encoded code points, as described in 6.1.4, and reads from it a single code point starting with the code unit at index position.

More information:

• ECMAScript reference

Panics

If position is smaller than size of string.

pub fn to_number(&self) -> f64

Abstract operation StringToNumber ( str )

More information:

• ECMAScript reference

pub fn code_points(&self) -> impl Iterator<Item = CodePoint> + Clone + use<'a>

Gets an iterator of all the Unicode codepoints of a JsStr.

pub fn contains(&self, element: u8) -> bool

Checks if the JsStr contains a byte.

pub fn code_points_lossy(self) -> impl Iterator<Item = char> + 'a

Gets an iterator of all the Unicode codepoints of a JsStr, replacing unpaired surrogates with the replacement character. This is faster than using Self::code_points.

pub fn to_std_string_with_surrogates( &self, ) -> impl Iterator<Item = Result<String, u16>> + use<'a>

Decodes a JsStr into an iterator of Result<String, u16>, returning surrogates as errors.

pub fn to_std_string(&self) -> Result<String, FromUtf16Error>

Decodes a JsStr into a String, returning an error if it contains any invalid data.

Errors

FromUtf16Error if it contains any invalid data.

pub fn to_std_string_escaped(&self) -> String

Decodes a JsStr into a String, replacing invalid data with its escaped representation in 4 digit hexadecimal.

pub fn to_std_string_lossy(&self) -> String

Decodes a JsStr into a String, replacing invalid data with the replacement character U+FFFD.

pub fn display_escaped(&self) -> JsStrDisplayEscaped<'a>

Gets a displayable escaped string.

This may be faster and has fewer allocations than format!("{}", str.to_string_escaped()) when displaying.

pub fn display_lossy(&self) -> JsStrDisplayLossy<'a>

Gets a displayable lossy string.

This may be faster and has fewer allocations than format!("{}", str.to_string_lossy()) when displaying.

Trait Implementations

impl<'a> Clone for JsStr<'a>

fn clone(&self) -> JsStr<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsStr<'_>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl From<JsStr<'_>> for JsString

fn from(value: JsStr<'_>) -> Self

Converts to this type from the input type.

impl Hash for JsStr<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

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 JsStr<'_>

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<&str> for JsStr<'_>

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 PartialEq<JsStr<'_>> for JsString

fn eq(&self, other: &JsStr<'_>) -> 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<JsStr<'a>> for [u16]

fn eq(&self, other: &JsStr<'a>) -> 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<JsString> for JsStr<'_>

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 PartialEq<str> for JsStr<'_>

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 PartialEq for JsStr<'_>

fn eq(&self, other: &Self) -> 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 JsStr<'_>

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: &Rhs) -> bool

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

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

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

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

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

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

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

impl<'a> Copy for JsStr<'a>

impl Eq for JsStr<'_>

impl Send for JsStr<'_>

impl Sync for JsStr<'_>