Struct rusty_v8::String

#[repr(C)]
pub struct String(_);

A JavaScript string value (ECMA-262, 4.3.17).

Implementations

impl String

pub fn empty<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, String>

pub fn new_from_utf8<'s>(
    scope: &mut HandleScope<'s, ()>,
    buffer: &[u8],
    new_type: NewStringType
) -> Option<Local<'s, String>>

Allocates a new string from UTF-8 data. Only returns an empty value when length > kMaxLength

pub fn new_from_one_byte<'s>(
    scope: &mut HandleScope<'s, ()>,
    buffer: &[u8],
    new_type: NewStringType
) -> Option<Local<'s, String>>

Allocates a new string from Latin-1 data. Only returns an empty value when length > kMaxLength.

pub fn new_from_two_byte<'s>(
    scope: &mut HandleScope<'s, ()>,
    buffer: &[u16],
    new_type: NewStringType
) -> Option<Local<'s, String>>

Allocates a new string from UTF-16 data. Only returns an empty value when length > kMaxLength.

pub fn length(&self) -> usize

Returns the number of characters (UTF-16 code units) in this string.

pub fn utf8_length(&self, scope: &mut Isolate) -> usize

Returns the number of bytes in the UTF-8 encoded representation of this string.

pub fn write(
    &self,
    scope: &mut Isolate,
    buffer: &mut [u16],
    start: usize,
    options: WriteOptions
) -> usize

Writes the contents of the string to an external buffer, as 16-bit (UTF-16) character codes.

pub fn write_one_byte(
    &self,
    scope: &mut Isolate,
    buffer: &mut [u8],
    start: usize,
    options: WriteOptions
) -> usize

Writes the contents of the string to an external buffer, as one-byte (Latin-1) characters.

pub fn write_utf8(
    &self,
    scope: &mut Isolate,
    buffer: &mut [u8],
    nchars_ref: Option<&mut usize>,
    options: WriteOptions
) -> usize

Writes the contents of the string to an external buffer, as UTF-8.

pub fn new<'s>(
    scope: &mut HandleScope<'s, ()>,
    value: &str
) -> Option<Local<'s, String>>

pub fn new_external_onebyte_static<'s>(
    scope: &mut HandleScope<'s, ()>,
    buffer: &'static [u8]
) -> Option<Local<'s, String>>

pub fn new_external_twobyte_static<'s>(
    scope: &mut HandleScope<'s, ()>,
    buffer: &'static [u16]
) -> Option<Local<'s, String>>

pub fn is_external(&self) -> bool

True if string is external

pub fn is_external_onebyte(&self) -> bool

True if string is external & one-byte (e.g: created with new_external_onebyte_static)

pub fn is_external_twobyte(&self) -> bool

True if string is external & two-byte (e.g: created with new_external_twobyte_static)

pub fn is_onebyte(&self) -> bool

True if string is known to contain only one-byte data. Doesn’t read the string so can return false positives.

For a method that will not return false positives at the cost of potentially reading the entire string, use contains_only_onebyte().

pub fn contains_only_onebyte(&self) -> bool

True if the string contains only one-byte data. Will read the entire string in some cases.

pub fn to_rust_string_lossy(&self, scope: &mut Isolate) -> String

Convenience function not present in the original V8 API.

Trait Implementations

impl Debug for String

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

Formats the value using the given formatter.

impl Deref for String

type Target = Name

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for String

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, 

Feeds a slice of this type into the given Hasher.

impl<'s> PartialEq<Name> for String

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'s> PartialEq<Primitive> for String

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'s> PartialEq<String> for Value

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'s> PartialEq<String> for Primitive

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'s> PartialEq<String> for Name

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'s> PartialEq<String> for String

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<'s> PartialEq<Value> for String

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for String