Struct Value 

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

The core Value type for all Sema data. NaN-boxed: stored as 8 bytes. Floats stored directly, everything else encoded in quiet-NaN payload space.

Implementations

impl Value

pub const NIL: Value

pub const TRUE: Value

pub const FALSE: Value

pub fn nil() -> Value

pub fn bool(b: bool) -> Value

pub fn int(n: i64) -> Value

pub fn float(f: f64) -> Value

pub fn char(c: char) -> Value

pub fn symbol_from_spur(spur: Spur) -> Value

pub fn symbol(s: &str) -> Value

pub fn keyword_from_spur(spur: Spur) -> Value

pub fn keyword(s: &str) -> Value

pub fn from_bigint(n: BigInt) -> Value

Construct an integer of any magnitude, normalizing to the tightest representation: values in i64 range become a fixnum/int-big, larger values are heap-boxed under TAG_BIGINT.

pub fn rational(r: BigRational) -> Value

Construct an exact rational, normalizing integer-valued rationals (e.g. 6/3) down to the tightest integer representation.

pub fn complex(re: SemaNumber, im: SemaNumber) -> Value

Construct a complex number from its real/imaginary tower components, normalizing an exact-zero imaginary part down to the real part alone.

pub fn string(s: &str) -> Value

pub fn string_owned(s: String) -> Value

Construct a string value from an already-owned String without the extra copy Value::string(&s) would make. Prefer this whenever the caller has just built the String and won’t use it again.

pub fn string_from_rc(rc: Rc<String>) -> Value

pub fn list(v: Vec<Value>) -> Value

pub fn list_from_rc(rc: Rc<Vec<Value>>) -> Value

pub fn vector(v: Vec<Value>) -> Value

pub fn vector_from_rc(rc: Rc<Vec<Value>>) -> Value

pub fn map(m: BTreeMap<Value, Value>) -> Value

pub fn map_from_rc(rc: Rc<BTreeMap<Value, Value>>) -> Value

pub fn hashmap(entries: Vec<(Value, Value)>) -> Value

pub fn hashmap_from_rc(rc: Rc<HashMap<Value, Value>>) -> Value

pub fn lambda(l: Lambda) -> Value

pub fn lambda_from_rc(rc: Rc<Lambda>) -> Value

pub fn macro_val(m: Macro) -> Value

pub fn macro_from_rc(rc: Rc<Macro>) -> Value

pub fn native_fn(f: NativeFn) -> Value

pub fn native_fn_from_rc(rc: Rc<NativeFn>) -> Value

pub fn prompt(p: Prompt) -> Value

pub fn prompt_from_rc(rc: Rc<Prompt>) -> Value

pub fn message(m: Message) -> Value

pub fn message_from_rc(rc: Rc<Message>) -> Value

pub fn conversation(c: Conversation) -> Value

pub fn conversation_from_rc(rc: Rc<Conversation>) -> Value

pub fn tool_def(t: ToolDefinition) -> Value

pub fn tool_def_from_rc(rc: Rc<ToolDefinition>) -> Value

pub fn agent(a: Agent) -> Value

pub fn agent_from_rc(rc: Rc<Agent>) -> Value

pub fn thunk(t: Thunk) -> Value

pub fn thunk_from_rc(rc: Rc<Thunk>) -> Value

pub fn record(r: Record) -> Value

pub fn record_from_rc(rc: Rc<Record>) -> Value

pub fn bytevector(bytes: Vec<u8>) -> Value

pub fn bytevector_from_rc(rc: Rc<Vec<u8>>) -> Value

pub fn f64_array(data: Vec<f64>) -> Value

pub fn f64_array_from_rc(rc: Rc<Vec<f64>>) -> Value

pub fn i64_array(data: Vec<i64>) -> Value

pub fn i64_array_from_rc(rc: Rc<Vec<i64>>) -> Value

pub fn multimethod(m: MultiMethod) -> Value

pub fn multimethod_from_rc(rc: Rc<MultiMethod>) -> Value

pub fn stream(s: impl SemaStream + 'static) -> Value

pub fn stream_from_rc(rc: Rc<StreamBox>) -> Value

pub fn async_promise(promise: AsyncPromise) -> Value

pub fn async_promise_id(id: PromiseId) -> Value

Build a promise Value from a runtime PromiseId. The registry owns the promise’s state; this is just the language-facing handle to it.

pub fn async_promise_from_rc(rc: Rc<AsyncPromise>) -> Value

Rebuild a promise handle Value from an existing Rc WITHOUT re-registering a GC candidate — used by the collector to upgrade a candidate Weak into a snapshot handle for the duration of a pass.

pub fn channel(ch: Channel) -> Value

pub fn channel_id(id: ChannelId) -> Value

Build a channel Value from a runtime ChannelId. The registry owns the channel’s buffer/state; this is just the language-facing handle to it.

pub fn channel_from_rc(rc: Rc<Channel>) -> Value

Rebuild a channel handle Value from an existing Rc WITHOUT re-registering a GC candidate — used by the collector to upgrade a candidate Weak into a snapshot handle for the duration of a pass.

pub fn mutable_array(items: Vec<Value>) -> Value

pub fn mutable_array_from_rc(rc: Rc<MutableArray>) -> Value

pub fn mutable_cell(value: Value) -> Value

pub fn mutable_cell_from_rc(rc: Rc<MutableCell>) -> Value

impl Value

pub fn raw_bits(&self) -> u64

Get the raw bits (for debugging/testing).

pub unsafe fn from_raw_bits(bits: u64) -> Value

Construct a Value from raw NaN-boxed bits.

Safety

Caller must ensure bits represents a valid NaN-boxed value. For immediate types (nil, bool, int, symbol, keyword, char), this is always safe. For heap-pointer types, the encoded pointer must be valid and have its Rc ownership accounted for (i.e., the caller must ensure the refcount is correct).

pub fn raw_tag(&self) -> Option<u64>

Get the NaN-boxing tag of a boxed value (0-63). Returns None for non-boxed values (floats).

pub fn as_native_fn_ref(&self) -> Option<&NativeFn>

Borrow the underlying NativeFn without bumping the Rc refcount. SAFETY: The returned reference is valid as long as this Value is alive.

pub fn is_float(&self) -> bool

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

pub fn view(&self) -> ValueView

Pattern-match friendly view of this value. For heap types, this bumps the Rc refcount.

pub fn view_ref(&self) -> ValueViewRef<'_>

Borrowing view — like view() but returns references instead of bumping Rc refcounts. Use this in hot paths like PartialEq, Hash, Ord, and Display.

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

pub fn is_nil(&self) -> bool

pub fn is_truthy(&self) -> bool

pub fn is_falsy(&self) -> bool

pub fn is_bool(&self) -> bool

pub fn is_int(&self) -> bool

pub fn is_bigint(&self) -> bool

pub fn is_rational(&self) -> bool

pub fn is_complex(&self) -> bool

pub fn is_symbol(&self) -> bool

pub fn is_keyword(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_list(&self) -> bool

pub fn is_pair(&self) -> bool

pub fn is_vector(&self) -> bool

pub fn is_map(&self) -> bool

pub fn is_lambda(&self) -> bool

pub fn is_native_fn(&self) -> bool

pub fn is_thunk(&self) -> bool

pub fn is_async_promise(&self) -> bool

pub fn is_channel(&self) -> bool

pub fn is_record(&self) -> bool

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

pub fn as_bigint(&self) -> Option<BigInt>

Lift any integer Value (fixnum, int-big, or bignum) to BigInt. None for non-integers.

pub fn as_rational(&self) -> Option<BigRational>

Lift any exact Value (fixnum, bignum, or rational) to BigRational. None for non-exact-numeric Values (including floats).

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

Lift any numeric Value into the tower type for arithmetic. None for non-numbers.

pub fn from_number(n: SemaNumber) -> Value

Lower a tower number to the tightest Value.

pub fn as_complex(&self) -> Option<SemaComplex>

Lift a complex Value to the tower’s Complex component pair. None for non-complex Values.

pub fn as_index(&self, name: &str) -> Result<usize, SemaError>

Convert a user-supplied integer to a usize index/count, rejecting non-integers and negative values. Centralizes the negativity guard that list/take, list/drop, string/repeat (and the Pattern-A audit sites) all need — a bare as usize would wrap a negative i64 to a huge value and trigger an OOM allocation or out-of-bounds panic.

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

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

pub fn as_str(&self) -> Option<&str>

pub fn as_string_rc(&self) -> Option<Rc<String>>

pub fn as_symbol(&self) -> Option<String>

pub fn as_symbol_spur(&self) -> Option<Spur>

pub fn as_keyword(&self) -> Option<String>

pub fn as_keyword_spur(&self) -> Option<Spur>

pub fn as_char(&self) -> Option<char>

pub fn as_list(&self) -> Option<&[Value]>

pub fn as_list_rc(&self) -> Option<Rc<Vec<Value>>>

pub fn as_seq(&self) -> Option<&[Value]>

Returns the contents as a slice if this is a list OR a vector.

pub fn as_vector(&self) -> Option<&[Value]>

pub fn as_vector_rc(&self) -> Option<Rc<Vec<Value>>>

pub fn as_map_rc(&self) -> Option<Rc<BTreeMap<Value, Value>>>

pub fn as_hashmap_rc(&self) -> Option<Rc<HashMap<Value, Value>>>

pub fn as_hashmap_ref(&self) -> Option<&HashMap<Value, Value>>

Borrow the underlying HashMap without bumping the Rc refcount.

pub fn as_map_ref(&self) -> Option<&BTreeMap<Value, Value>>

Borrow the underlying BTreeMap without bumping the Rc refcount.

pub fn with_hashmap_mut_if_unique<R>( &self, f: impl FnOnce(&mut HashMap<Value, Value>) -> R, ) -> Option<R>

If this is a hashmap with refcount==1, mutate it in place. Returns None if not a hashmap or if shared (refcount > 1). SAFETY: relies on no other references to the inner data existing.

pub fn with_map_mut_if_unique<R>( &self, f: impl FnOnce(&mut BTreeMap<Value, Value>) -> R, ) -> Option<R>

If this is a map (BTreeMap) with refcount==1, mutate it in place. Returns None if not a map or if shared (refcount > 1).

pub fn into_hashmap_rc(self) -> Result<Rc<HashMap<Value, Value>>, Value>

Consume this Value and extract the inner Rc without a refcount bump. Returns Err(self) if not a hashmap.

pub fn into_map_rc(self) -> Result<Rc<BTreeMap<Value, Value>>, Value>

Consume this Value and extract the inner Rc without a refcount bump. Returns Err(self) if not a map.

pub fn as_lambda_rc(&self) -> Option<Rc<Lambda>>

pub fn as_macro_rc(&self) -> Option<Rc<Macro>>

pub fn as_native_fn_rc(&self) -> Option<Rc<NativeFn>>

pub fn as_thunk_rc(&self) -> Option<Rc<Thunk>>

pub fn as_record(&self) -> Option<&Record>

pub fn as_record_rc(&self) -> Option<Rc<Record>>

pub fn as_bytevector(&self) -> Option<&[u8]>

pub fn as_bytevector_rc(&self) -> Option<Rc<Vec<u8>>>

pub fn as_f64_array(&self) -> Option<&[f64]>

pub fn as_f64_array_rc(&self) -> Option<Rc<Vec<f64>>>

pub fn as_i64_array(&self) -> Option<&[i64]>

pub fn as_i64_array_rc(&self) -> Option<Rc<Vec<i64>>>

pub fn as_stream(&self) -> Option<&StreamBox>

pub fn as_stream_rc(&self) -> Option<Rc<StreamBox>>

pub fn as_prompt_rc(&self) -> Option<Rc<Prompt>>

pub fn as_message_rc(&self) -> Option<Rc<Message>>

pub fn as_conversation_rc(&self) -> Option<Rc<Conversation>>

pub fn as_tool_def_rc(&self) -> Option<Rc<ToolDefinition>>

pub fn as_agent_rc(&self) -> Option<Rc<Agent>>

pub fn as_multimethod_rc(&self) -> Option<Rc<MultiMethod>>

pub fn as_mutable_array(&self) -> Option<&MutableArray>

pub fn as_mutable_array_rc(&self) -> Option<Rc<MutableArray>>

pub fn as_mutable_cell(&self) -> Option<&MutableCell>

pub fn as_mutable_cell_rc(&self) -> Option<Rc<MutableCell>>

pub fn is_mutable_container(&self) -> bool

True for interior-mutable containers (mutable arrays and cells), whose contents can change after a map insertion. Map constructors reject these as keys — a mutated key would silently corrupt lookup order.

pub fn contains_mutable_container(&self) -> bool

True if this value is, or transitively contains, an interior-mutable container. Map keys must be deeply immutable: a vector wrapping a mutable array still mutates underneath the map, corrupting lookup order just as a bare mutable key would (Ord recurses into container elements). Iterative worklist — no visited set or depth cap needed because the walk never descends into a mutable container (it returns true on sight) and cycles are only constructible through one.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl Drop for Value

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Value

impl Hash for Value

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Value

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.