Struct String 

pub struct String<'s> {
    str: Local<'s, *mut JSString>,
}

Represents a primitive string in the JS Runtime. Strings in JS are immutable and are copied on modification, other than concatenating and slicing.

Refer to MDN for more details.

Fields

str: Local<'s, *mut JSString>

Implementations

impl<'s> String<'s>

pub fn new(cx: &Context) -> String<'_>

Creates an empty String.

pub fn copy_from_str<'cx>(cx: &'cx Context, string: &str) -> Option<String<'cx>>

Creates a new String with a given string, by copying it to the JS Runtime.

pub fn from_latin1( cx: &Context, string: ByteString<Latin1>, ) -> Result<String<'_>, ByteString<Latin1>>

Creates a new string by moving ownership of the Latin-1 string to the JS Runtime temporarily. Returns the bytes if the creation of the string in the runtime fails.

pub fn from_wstring( cx: &Context, string: WString<NativeEndian>, ) -> Result<String<'_>, WString<NativeEndian>>

Creates a new string by moving ownership of the UTF-16 string to the JS Runtime temporarily. Returns the string if the creation of the string in the runtime fails.

pub fn slice<'cx>(&self, cx: &'cx Context, range: Range<usize>) -> String<'cx>

Returns a slice of a String as a new String.

pub fn concat<'cx>(&self, cx: &'cx Context, other: &String<'_>) -> String<'cx>

Concatenates two Strings into a new String. The resultant String is not linear.

pub fn compare(&self, cx: &Context, other: &String<'_>) -> i32

Compares two Strings.

pub fn is_linear(&self) -> bool

Checks if a string is linear (contiguous) in memory.

pub fn is_latin1(&self) -> bool

Checks if a string consists of only Latin-1 characters.

pub fn is_utf16(&self) -> bool

Checks if a string consists of UTF-16 characters.

pub fn char_at(&self, cx: &Context, index: usize) -> u16

Returns the UTF-16 codepoint at the given character. Returns None if the string is not linear.

pub fn as_latin1(&self, cx: &Context) -> Option<&'s [u8]>

Converts the String into a slice of Latin-1 characters. Returns None if the string contains non-Latin-1 characters.

pub fn as_wstr(&self, cx: &Context) -> Result<Option<&'s WStr<NativeEndian>>>

Converts the String into a WStr. Returns None if the string contains only Latin-1 characters.

pub fn as_wtf16(&self, cx: &Context) -> Option<&'s [u16]>

pub fn as_ref(&self, cx: &Context) -> StringRef<'s>

pub fn to_owned(&self, cx: &Context) -> Result<RustString>

Converts a String to an owned String.

Methods from Deref<Target = Local<'s, *mut JSString>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

Trait Implementations

impl<'s> Debug for String<'s>

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

Formats the value using the given formatter.

impl<'s> Deref for String<'s>

type Target = Local<'s, *mut JSString>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for String<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'s> From<Local<'s, *mut JSString>> for String<'s>

fn from(str: Local<'s, *mut JSString>) -> String<'s>

Converts to this type from the input type.

impl<'cx> FromValue<'cx> for String<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, strict: bool, config: (), ) -> Result<String<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToPropertyKey<'cx> for String<'cx>

fn to_key(&self, cx: &'cx Context) -> Option<PropertyKey<'cx>>

Converts self to a new PropertyKey. Returns None when conversion fails.

impl<'cx> ToValue<'cx> for String<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes