Struct EcmaString 

pub struct EcmaString(/* private fields */);

An immutable ECMAScript string represented exactly as UTF-16 code units.

Unlike Rust’s str, this type preserves every u16 sequence, including unpaired surrogate code units. Converting to UTF-8 is therefore explicit.

Implementations

impl EcmaString

pub fn from_utf8(value: &str) -> Self

Encodes a well-formed UTF-8 string as ECMAScript UTF-16 code units.

pub fn from_units(units: &[u16]) -> Self

Copies exact UTF-16 code units, including unpaired surrogates.

pub fn as_units(&self) -> &[u16]

Returns the exact UTF-16 code units.

pub fn len_units(&self) -> usize

Returns the number of UTF-16 code units.

pub fn is_empty(&self) -> bool

Returns whether this string has no UTF-16 code units.

pub fn unit_at(&self, offset: usize) -> Option<u16>

Returns a code unit at offset, if present.

pub fn slice_units(&self, range: Range<usize>) -> Self

Returns a copy of the requested code-unit range.

This deliberately permits ranges that split a surrogate pair, matching ECMAScript’s code-unit indexing semantics.

pub fn is_well_formed(&self) -> bool

Returns whether every surrogate code unit is part of a valid pair.

pub fn eq_ascii(&self, value: &str) -> bool

Compares with an ASCII string without allocating.

pub fn code_points(&self) -> impl Iterator<Item = (usize, u32)> + '_

Iterates decoded code points with their UTF-16 code-unit offsets.

Valid surrogate pairs yield one supplementary code point. Unpaired surrogates yield their raw code-unit values.

pub fn to_utf8_strict(&self) -> Result<String, IllFormedUtf16>

Converts to UTF-8, rejecting the first unpaired surrogate.

Errors

Returns IllFormedUtf16 with the offset of the first unpaired surrogate code unit.

pub fn to_utf8_lossy(&self) -> String

Converts to UTF-8, replacing each unpaired surrogate with U+FFFD.

Trait Implementations

impl Clone for EcmaString

fn clone(&self) -> EcmaString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EcmaString

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

Formats the value using the given formatter.

impl Default for EcmaString

fn default() -> EcmaString

Returns the “default value” for a type.

impl Eq for EcmaString

impl Hash for EcmaString

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 EcmaString

fn cmp(&self, other: &EcmaString) -> 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 EcmaString

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EcmaString

fn partial_cmp(&self, other: &EcmaString) -> 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 StructuralPartialEq for EcmaString