Enum Value 

pub enum Value {
    Nil,
    Bool(bool),
    Long(i64),
    Double(f64),
    BigInt(GcPtr<BigInt>),
    BigDecimal(GcPtr<BigDecimal>),
    Ratio(GcPtr<Ratio<BigInt>>),
    Char(char),
    Str(GcPtr<String>),
    Uuid(u128),
    Pattern(GcPtr<Regex>),
    Matcher(GcPtr<Matcher>),
    Symbol(GcPtr<Symbol>),
    Keyword(GcPtr<Keyword>),
    List(GcPtr<PersistentList>),
    Vector(GcPtr<PersistentVector>),
    Map(MapValue),
    Set(SetValue),
    Queue(GcPtr<PersistentQueue>),
    TransientMap(GcPtr<TransientMap>),
    TransientSet(GcPtr<TransientSet>),
    TransientVector(GcPtr<TransientVector>),
    IntArray(GcPtr<Mutex<Vec<i32>>>),
    LongArray(GcPtr<Mutex<Vec<i64>>>),
    ShortArray(GcPtr<Mutex<Vec<i16>>>),
    ByteArray(GcPtr<Mutex<Vec<i8>>>),
    FloatArray(GcPtr<Mutex<Vec<f32>>>),
    DoubleArray(GcPtr<Mutex<Vec<f64>>>),
    BooleanArray(GcPtr<Mutex<Vec<bool>>>),
    CharArray(GcPtr<Mutex<Vec<char>>>),
    ObjectArray(GcPtr<ObjectArray>),
    NativeFunction(GcPtr<NativeFn>),
    Fn(GcPtr<CljxFn>),
    Macro(GcPtr<CljxFn>),
    BoundFn(GcPtr<BoundFn>),
    Var(GcPtr<Var>),
    Atom(GcPtr<Atom>),
    SharedAtom(Arc<SharedAtom>),
    ByteBlob(Arc<[u8]>),
    Reduced(Box<Value>),
    Namespace(GcPtr<Namespace>),
    LazySeq(GcPtr<LazySeq>),
    Cons(GcPtr<CljxCons>),
    Protocol(GcPtr<Protocol>),
    ProtocolFn(GcPtr<ProtocolFn>),
    MultiFn(GcPtr<MultiFn>),
    Volatile(GcPtr<Volatile>),
    Delay(GcPtr<Delay>),
    Promise(GcPtr<CljxPromise>),
    Future(GcPtr<CljxFuture>),
    Agent(GcPtr<Agent>),
    TypeInstance(GcPtr<TypeInstance>),
    NativeObject(GcPtr<NativeObjectBox>),
    Resource(ResourceHandle),
    WithMeta(Box<Value>, Box<Value>),
    Error(GcPtr<ExceptionInfo>),
}

The central runtime type: every Clojure value is a Value.

Small scalars (Nil, Bool, Long, Double, Char) are stored inline. All heap-allocated types go behind GcPtr so that clone() is O(1).

Variants

Nil

Bool(bool)

Long(i64)

Double(f64)

BigInt(GcPtr<BigInt>)

BigDecimal(GcPtr<BigDecimal>)

Ratio(GcPtr<Ratio<BigInt>>)

Char(char)

Str(GcPtr<String>)

Uuid(u128)

Pattern(GcPtr<Regex>)

Matcher(GcPtr<Matcher>)

Symbol(GcPtr<Symbol>)

Keyword(GcPtr<Keyword>)

List(GcPtr<PersistentList>)

Vector(GcPtr<PersistentVector>)

Map(MapValue)

Small maps (≤8 entries) are stored as an ArrayMap; larger ones as a HashMap. Also contains sorted map.

Set(SetValue)

Queue(GcPtr<PersistentQueue>)

TransientMap(GcPtr<TransientMap>)

TransientSet(GcPtr<TransientSet>)

TransientVector(GcPtr<TransientVector>)

IntArray(GcPtr<Mutex<Vec<i32>>>)

LongArray(GcPtr<Mutex<Vec<i64>>>)

ShortArray(GcPtr<Mutex<Vec<i16>>>)

ByteArray(GcPtr<Mutex<Vec<i8>>>)

FloatArray(GcPtr<Mutex<Vec<f32>>>)

DoubleArray(GcPtr<Mutex<Vec<f64>>>)

BooleanArray(GcPtr<Mutex<Vec<bool>>>)

CharArray(GcPtr<Mutex<Vec<char>>>)

ObjectArray(GcPtr<ObjectArray>)

NativeFunction(GcPtr<NativeFn>)

Fn(GcPtr<CljxFn>)

Macro(GcPtr<CljxFn>)

BoundFn(GcPtr<BoundFn>)

Var(GcPtr<Var>)

Atom(GcPtr<Atom>)

SharedAtom(Arc<SharedAtom>)

Cross-isolate mutable reference backed by Arc<ArcSwap<SharedValue>>. Unlike Atom, a SharedAtom can cross the isolate boundary (the Arc is cloned, not deep-copied) and its contents are lock-free CAS-swapped.

ByteBlob(Arc<[u8]>)

Immutable refcounted byte buffer (the BEAM off-heap-binary trick). Shared without copy across the isolate boundary; refcount drops to zero only when every isolate releases its reference.

Reduced(Box<Value>)

Namespace(GcPtr<Namespace>)

LazySeq(GcPtr<LazySeq>)

A deferred sequence cell — realized at most once.

Cons(GcPtr<CljxCons>)

A realized cons cell whose tail may itself be lazy.

Protocol(GcPtr<Protocol>)

ProtocolFn(GcPtr<ProtocolFn>)

MultiFn(GcPtr<MultiFn>)

Volatile(GcPtr<Volatile>)

Delay(GcPtr<Delay>)

Promise(GcPtr<CljxPromise>)

Future(GcPtr<CljxFuture>)

Agent(GcPtr<Agent>)

TypeInstance(GcPtr<TypeInstance>)

NativeObject(GcPtr<NativeObjectBox>)

Resource(ResourceHandle)

WithMeta(Box<Value>, Box<Value>)

A value with attached metadata. Transparent for equality, hashing, display.

Error(GcPtr<ExceptionInfo>)

Implementations

impl Value

pub fn unwrap_meta(&self) -> &Value

Strip any WithMeta wrapper, returning the underlying value.

pub fn get_meta(&self) -> Option<&Value>

Return metadata if present, or None.

pub fn with_meta(self, meta: Value) -> Value

Return a new value with metadata attached.

impl Value

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

A human-readable type name for error messages.

pub fn string(s: impl Into<String>) -> Self

Convenience: wrap a &str in Value::Str.

pub fn map_entry(key: Value, val: Value) -> Self

Convenience: build a [key val] map entry (a tagged 2-element vector).

pub fn is_map_entry(&self) -> bool

True only for map entries ([k v] pairs from seq’ing a map, find, or the map-entry constructor) — not for plain 2-element vectors.

pub fn symbol(s: Symbol) -> Self

Convenience: wrap a Symbol.

pub fn keyword(k: Keyword) -> Self

Convenience: wrap a Keyword.

pub fn is_sequential(&self) -> bool

True for sequential collections (list, vector, lazy seq, cons).

pub fn is_coll(&self) -> bool

True for any collection.

Trait Implementations

impl ClojureHash for Value

fn clojure_hash(&self) -> u32

impl Clone for Value

fn clone(&self) -> Value

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

Prints in pr-str style (readable): strings are quoted, chars use \ notation.

impl Eq for Value

impl FromIterator<Value> for PersistentHashSet

fn from_iter<I: IntoIterator<Item = Value>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for PersistentList

fn from_iter<I: IntoIterator<Item = Value>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for SortedSet

fn from_iter<I: IntoIterator<Item = Value>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for PersistentVector

fn from_iter<I: IntoIterator<Item = Value>>(iter: I) -> Self

Creates a value from an iterator.

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.

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.

impl Trace for Value

fn trace(&self, visitor: &mut MarkVisitor)

fn gc_size_extra(&self) -> usize