Enum Primitive 

#[repr(u8)]
pub enum Primitive<'a> {
    Undefined = 1,
    Null = 2,
    Boolean(bool),
    String(HeapString<'a>),
    SmallString(SmallString),
    Symbol(Symbol<'a>),
    Number(HeapNumber<'a>),
    Integer(SmallInteger),
    SmallF64(SmallF64),
    BigInt(HeapBigInt<'a>),
    SmallBigInt(SmallBigInt),
}

Variants

Undefined = 1

6.1.1 The Undefined Type

Null = 2

6.1.2 The Null Type

Boolean(bool)

6.1.3 The Boolean Type

String(HeapString<'a>)

6.1.4 The String Type

UTF-8 string on the heap. Accessing the data must be done through the Agent. ECMAScript specification compliant UTF-16 indexing is implemented through an index mapping.

SmallString(SmallString)

6.1.4 The String Type

7-byte UTF-8 string on the stack. End of the string is determined by the first 0xFF byte in the data. UTF-16 indexing is calculated on demand from the data.

Symbol(Symbol<'a>)

6.1.5 The Symbol Type

Number(HeapNumber<'a>)

6.1.6.1 The Number Type

f64 on the heap. Accessing the data must be done through the Agent.

Integer(SmallInteger)

6.1.6.1 The Number Type

53-bit signed integer on the stack.

SmallF64(SmallF64)

6.1.6.1 The Number Type

56-bit f64 on the stack. The missing byte is a zero least significant byte.

BigInt(HeapBigInt<'a>)

6.1.6.2 The BigInt Type

Unlimited size integer data on the heap. Accessing the data must be done through the Agent.

SmallBigInt(SmallBigInt)

6.1.6.2 The BigInt Type

56-bit signed integer on the stack.

Implementations

impl Primitive<'_>

pub fn is_boolean(self) -> bool

pub fn is_bigint(self) -> bool

pub fn is_null(self) -> bool

pub fn is_number(self) -> bool

pub fn is_string(self) -> bool

pub fn is_symbol(self) -> bool

pub fn is_undefined(self) -> bool

Trait Implementations

impl Bindable for Primitive<'_>

type Of<'a> = Primitive<'a>

Bound representation of self. This must always be effectively equal to Self<'a>. Note that we cannot write Self<'a> directly because Self cannot have lifetime parameters attached to it.

fn unbind(self) -> Self::Of<'static>

Unbind this value from the garbage collector lifetime. This is necessary for eg. when using the value as a parameter in a call that can perform garbage collection.

fn bind<'a>(self, _: NoGcScope<'a, '_>) -> Self::Of<'a>

Bind this value to the garbage collector lifetime. This is necessary to enable the borrow checker to check that bindable values are not use-after-free.

impl<'a> Clone for Primitive<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Primitive<'a>

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

Formats the value using the given formatter.

impl<'a> From<BigInt<'a>> for Primitive<'a>

fn from(value: BigInt<'a>) -> Primitive<'a>

Converts to this type from the input type.

impl<'a> From<HeapString<'a>> for Primitive<'a>

fn from(value: HeapString<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Numeric<'a>> for Primitive<'a>

fn from(value: Numeric<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Primitive<'a>> for Value<'a>

fn from(primitive: Primitive<'a>) -> Self

Converts to this type from the input type.

impl From<SmallString> for Primitive<'static>

fn from(value: SmallString) -> Self

Converts to this type from the input type.

impl<'a> From<Symbol<'a>> for Primitive<'a>

fn from(value: Symbol<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Primitive<'a>

fn eq(&self, other: &Primitive<'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 Rootable for Primitive<'_>

type RootRepr = PrimitiveRootRepr

fn to_root_repr(value: Self) -> Result<Self::RootRepr, HeapRootData>

Convert a rootable value to a root representation directly if the value does not need to be rooted, or return its heap root representation as the error value.

fn from_root_repr(value: &Self::RootRepr) -> Result<Self, HeapRootRef>

Convert a rootable value’s root representation to the value type directly if it didn’t need to be rooted in the first place, or return its heap root reference as the error value.

fn from_heap_ref(heap_ref: HeapRootRef) -> Self::RootRepr

Convert a heap root reference to a root representation.

fn from_heap_data(heap_data: HeapRootData) -> Option<Self>

Convert the rooted type’s heap data value to the type itself. A failure to convert indicates that the heap is corrupted or the value’s root representation was misused and points to a reused heap root data slot.

impl<'a> TryFrom<Primitive<'a>> for BigInt<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Primitive<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Primitive<'a>> for HeapBigInt<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Primitive<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Primitive<'a>> for Number<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Primitive<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Primitive<'a>> for Numeric<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Primitive<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Primitive<'a>> for String<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Primitive<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Primitive<'a>> for Symbol<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Primitive<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for Primitive<'a>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for Primitive<'a>

impl RootableSealed for Primitive<'_>

impl<'a> StructuralPartialEq for Primitive<'a>