Struct String

pub struct String<'js>(/* private fields */);

Rust representation of a JavaScript string.

Implementations

impl<'js> String<'js>

pub fn to_string(&self) -> Result<String, Error>

Convert the JavaScript string to a Rust string.

pub fn to_cstring(self) -> Result<CString<'js>, Error>

Convert the Javascript string to a Javascript C string.

pub fn from_str(ctx: Ctx<'js>, s: &str) -> Result<String<'js>, Error>

Create a new JavaScript string from an Rust string.

impl<'js> String<'js>

pub fn as_value(&self) -> &Value<'js>

Reference to value

pub fn into_value(self) -> Value<'js>

Convert into value

pub fn into_inner(self) -> Value<'js>

Returns the underlying super type.

pub fn as_inner(&self) -> &Value<'js>

Returns a reference to the underlying super type.

pub fn ctx(&self) -> &Ctx<'js>

Returns the Ctx object associated with this value

pub fn from_value(value: Value<'js>) -> Result<String<'js>, Error>

Convert from value

Methods from Deref<Target = Value<'js>>

pub fn ctx(&self) -> &Ctx<'js>

Returns the Ctx object associated with this value.

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

Try get bool from value

pub fn as_int(&self) -> Option<i32>

Try get int from value

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

Try get float from value

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

Try get any number from value

pub fn is_null(&self) -> bool

Returns if the value is the JavaScript null value.

pub fn is_undefined(&self) -> bool

Returns if the value is the JavaScript undefined value.

pub fn is_bool(&self) -> bool

Check if the value is a bool

pub fn is_int(&self) -> bool

Check if the value is an int

pub fn is_float(&self) -> bool

Check if the value is a float

pub fn is_number(&self) -> bool

Check if the value is an any number

pub fn is_string(&self) -> bool

Check if the value is a string

pub fn is_symbol(&self) -> bool

Check if the value is a symbol

pub fn is_object(&self) -> bool

Check if the value is an object

pub fn is_module(&self) -> bool

Check if the value is a module

pub fn is_array(&self) -> bool

Check if the value is an array

pub fn is_function(&self) -> bool

Check if the value is a function

pub fn is_constructor(&self) -> bool

Check if the value is a constructor function

pub fn is_promise(&self) -> bool

Check if the value is a promise.

pub fn is_exception(&self) -> bool

Check if the value is an exception

pub fn is_error(&self) -> bool

Check if the value is an error

pub fn as_value(&self) -> &Value<'js>

Reference as value

pub fn get<T>(&self) -> Result<T, Error>

where T: FromJs<'js>,

Convert from value to specified type

pub fn as_raw(&self) -> JSValue

Returns the raw C library JavaScript value.

pub fn type_of(&self) -> Type

Get the type of value

pub fn type_name(&self) -> &'static str

Get the name of type

pub unsafe fn ref_string(&self) -> &String<'js>

Interpret as String

Safety

You should be sure that the value already is of required type before to do it.

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

Try reinterpret as String

pub unsafe fn ref_symbol(&self) -> &Symbol<'js>

Interpret as Symbol

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_symbol(&self) -> Option<&Symbol<'js>>

Try reinterpret as Symbol

pub unsafe fn ref_object(&self) -> &Object<'js>

Interpret as Object

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_object(&self) -> Option<&Object<'js>>

Try reinterpret as Object

pub unsafe fn ref_function(&self) -> &Function<'js>

Interpret as Function

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_function(&self) -> Option<&Function<'js>>

Try reinterpret as Function

pub unsafe fn ref_constructor(&self) -> &Constructor<'js>

Interpret as Constructor

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_constructor(&self) -> Option<&Constructor<'js>>

Try reinterpret as Constructor

pub unsafe fn ref_promise(&self) -> &Promise<'js>

Interpret as Promise

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_promise(&self) -> Option<&Promise<'js>>

Try reinterpret as Promise

pub unsafe fn ref_array(&self) -> &Array<'js>

Interpret as Array

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_array(&self) -> Option<&Array<'js>>

Try reinterpret as Array

pub unsafe fn ref_exception(&self) -> &Exception<'js>

Interpret as Exception

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_exception(&self) -> Option<&Exception<'js>>

Try reinterpret as Exception

pub unsafe fn ref_big_int(&self) -> &BigInt<'js>

Interpret as BigInt

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_big_int(&self) -> Option<&BigInt<'js>>

Try reinterpret as BigInt

Trait Implementations

impl<'js> AsRef<Value<'js>> for String<'js>

fn as_ref(&self) -> &Value<'js>

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

impl<'js> Clone for String<'js>

fn clone(&self) -> String<'js>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js> Debug for String<'js>

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

Formats the value using the given formatter.

impl<'js> Deref for String<'js>

type Target = Value<'js>

The resulting type after dereferencing.

fn deref(&self) -> &<String<'js> as Deref>::Target

Dereferences the value.

impl<'js> From<String<'js>> for Value<'js>

fn from(value: String<'js>) -> Value<'js>

Converts to this type from the input type.

impl<'js> FromAtom<'js> for String<'js>

fn from_atom(atom: Atom<'js>) -> Result<String<'js>, Error>

impl<'js> FromJs<'js> for String<'js>

fn from_js(_: &Ctx<'js>, value: Value<'js>) -> Result<String<'js>, Error>

impl<'js> Hash for String<'js>

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

where __H: Hasher,

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<'js> IntoAtom<'js> for String<'js>

fn into_atom(self, ctx: &Ctx<'js>) -> Result<Atom<'js>, Error>

impl<'js> IntoJs<'js> for String<'js>

fn into_js(self, _ctx: &Ctx<'js>) -> Result<Value<'js>, Error>

impl<'js> JsLifetime<'js> for String<'js>

type Changed<'to> = String<'to>

The target which has the same type as a Self but with another lifetime 't

impl<'js> PartialEq for String<'js>

fn eq(&self, other: &String<'js>) -> 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<'js> Trace<'js> for String<'js>

fn trace<'a>(&self, tracer: Tracer<'a, 'js>)

impl<'js> StructuralPartialEq for String<'js>