Struct NanBoxedValue 

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

An 8-byte NaN-boxed value

This is the core type for the NaN-boxing optimization. All Seq values are encoded into exactly 8 bytes.

Implementations

impl NanBoxedValue

pub fn is_float(self) -> bool

Check if this value is a float (not in the NaN-box range)

pub fn is_boxed(self) -> bool

Check if this value is a boxed (non-float) value

pub fn tag(self) -> u8

Get the type tag (only valid if is_boxed() is true)

pub fn payload(self) -> u64

Get the 47-bit payload (only valid if is_boxed() is true)

pub fn is_int(self) -> bool

Check if this is an Int

pub fn is_bool(self) -> bool

Check if this is a Bool

pub fn is_string(self) -> bool

Check if this is a String

pub fn is_symbol(self) -> bool

Check if this is a Symbol

pub fn is_variant(self) -> bool

Check if this is a Variant

pub fn is_map(self) -> bool

Check if this is a Map

pub fn is_quotation(self) -> bool

Check if this is a Quotation

pub fn is_closure(self) -> bool

Check if this is a Closure

pub fn is_channel(self) -> bool

Check if this is a Channel

pub fn is_weave_ctx(self) -> bool

Check if this is a WeaveCtx

pub fn from_float(f: f64) -> Self

Create a NaN-boxed float

If the float is NaN, it’s canonicalized to avoid collision with boxed values.

pub fn from_int(n: i64) -> Self

Create a NaN-boxed integer

Panics

Panics if the integer is outside the 47-bit signed range.

pub fn try_from_int(n: i64) -> Option<Self>

Create a NaN-boxed integer, returning None if out of range

pub fn from_bool(b: bool) -> Self

Create a NaN-boxed boolean

pub fn from_string_ptr(ptr: *const SeqString) -> Self

Create a NaN-boxed string pointer

Safety

The pointer must be valid and properly aligned.

pub fn from_symbol_ptr(ptr: *const SeqString) -> Self

Create a NaN-boxed symbol pointer

Safety

The pointer must be valid and properly aligned.

pub fn from_variant_ptr(ptr: *const Arc<VariantData>) -> Self

Create a NaN-boxed variant pointer

pub fn from_map_ptr(ptr: *const Box<HashMap<MapKey, Value>>) -> Self

Create a NaN-boxed map pointer

pub fn from_quotation_ptr(ptr: *const QuotationData) -> Self

Create a NaN-boxed quotation pointer

pub fn from_closure_ptr(ptr: *const ClosureData) -> Self

Create a NaN-boxed closure pointer

pub fn from_channel_ptr(ptr: *const Arc<ChannelData>) -> Self

Create a NaN-boxed channel pointer

pub fn from_weave_ctx_ptr(ptr: *const WeaveCtxData) -> Self

Create a NaN-boxed weave context pointer

pub fn as_float(self) -> f64

Extract a float value

Panics

Panics in debug mode if this is not a float.

pub fn as_int(self) -> i64

Extract an integer value

Panics

Panics in debug mode if this is not an integer.

pub fn as_bool(self) -> bool

Extract a boolean value

Panics

Panics in debug mode if this is not a boolean.

pub unsafe fn as_string_ptr(self) -> *const SeqString

Extract a string pointer

Safety

The caller must ensure this is a String value.

pub unsafe fn as_symbol_ptr(self) -> *const SeqString

Extract a symbol pointer

Safety

The caller must ensure this is a Symbol value.

pub unsafe fn as_variant_ptr(self) -> *const Arc<VariantData>

Extract a variant pointer

Safety

The caller must ensure this is a Variant value.

pub unsafe fn as_map_ptr(self) -> *const Box<HashMap<MapKey, Value>>

Extract a map pointer

Safety

The caller must ensure this is a Map value.

pub unsafe fn as_quotation_ptr(self) -> *const QuotationData

Extract a quotation pointer

Safety

The caller must ensure this is a Quotation value.

pub unsafe fn as_closure_ptr(self) -> *const ClosureData

Extract a closure pointer

Safety

The caller must ensure this is a Closure value.

pub unsafe fn as_channel_ptr(self) -> *const Arc<ChannelData>

Extract a channel pointer

Safety

The caller must ensure this is a Channel value.

pub unsafe fn as_weave_ctx_ptr(self) -> *const WeaveCtxData

Extract a weave context pointer

Safety

The caller must ensure this is a WeaveCtx value.

pub fn to_bits(self) -> u64

Get the raw 64-bit representation

pub unsafe fn from_bits(bits: u64) -> Self

Create from raw 64-bit representation

Safety

The caller must ensure the bits represent a valid NanBoxedValue.

impl NanBoxedValue

pub fn from_value(value: &Value) -> Self

Convert a Value to a NanBoxedValue

This clones heap-allocated data and stores pointers in the NaN-boxed format. The caller is responsible for ensuring the returned NanBoxedValue is properly dropped (via drop_nanboxed) to avoid memory leaks.

Panics

Panics if an integer value is outside the 47-bit range.

pub unsafe fn to_value(self) -> Value

Convert a NanBoxedValue back to a Value

This reconstructs the Value from the NaN-boxed representation. For heap-allocated types, this takes ownership of the underlying memory.

Safety

The NanBoxedValue must have been created by from_value and not yet converted back or dropped. Each NanBoxedValue should only be converted to Value once.

pub fn clone_nanboxed(&self) -> Self

Clone a NanBoxedValue, properly cloning any heap-allocated data

For pointer types, this creates new heap allocations.

pub unsafe fn drop_nanboxed(self)

Drop a NanBoxedValue, freeing any heap-allocated data

This must be called for NanBoxedValues that hold pointer types to avoid memory leaks.

Safety

The NanBoxedValue must have been created by from_value or clone_nanboxed and not yet dropped or converted to Value.

Trait Implementations

impl Clone for NanBoxedValue

fn clone(&self) -> NanBoxedValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NanBoxedValue

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

Formats the value using the given formatter.

impl Default for NanBoxedValue

fn default() -> Self

Returns the “default value” for a type.

impl Copy for NanBoxedValue

impl Send for NanBoxedValue

impl Sync for NanBoxedValue