Enum Value

pub enum Value<C: 'static + Context> {
    AtomicWord(AtomicIsize, C::ValueMeta),
    BuiltinFunction(Symbol, C::BuiltinFunction, C::ValueMeta),
    Byte(u8, C::ValueMeta),
    Bytes(Gc<Vec<u8>>, C::ValueMeta),
    Cons(Gc<Value<C>>, Gc<Value<C>>, C::ValueMeta),
    Fixnum(isize, C::ValueMeta),
    Func(Option<Symbol>, Gc<Args<C>>, C::UserFunction, C::ValueMeta),
    Object(C::ObjectVtable, Vec<Gc<Value<C>>>, C::ValueMeta),
    Nil(C::ValueMeta),
    String(Gc<String>, C::ValueMeta),
    Symbol(Symbol, C::ValueMeta),
    Vector(Vec<Gc<Value<C>>>, C::ValueMeta),
}

A single OftLisp value.

Variants

AtomicWord(AtomicIsize, C::ValueMeta)

A mutable, signed, machine-sized integer.

BuiltinFunction(Symbol, C::BuiltinFunction, C::ValueMeta)

A built-in function.

Byte(u8, C::ValueMeta)

An unsigned 8-bit integer.

Bytes(Gc<Vec<u8>>, C::ValueMeta)

A vector of arbitrary bytes, not subject to the UTF-8 condition of Strings.

Cons(Gc<Value<C>>, Gc<Value<C>>, C::ValueMeta)

A cons cell, used to create lists, trees, and other data structures.

Fixnum(isize, C::ValueMeta)

A signed machine-sized integer.

Func(Option<Symbol>, Gc<Args<C>>, C::UserFunction, C::ValueMeta)

A user-defined function.

Object(C::ObjectVtable, Vec<Gc<Value<C>>>, C::ValueMeta)

The object type, containing a vtable and values.

Nil(C::ValueMeta)

The nil literal, used to terminate lists and signal failure (or the lack of interesting results).

String(Gc<String>, C::ValueMeta)

A UTF-8 string.

Symbol(Symbol, C::ValueMeta)

An interned symbol, which may be compared in O(1).

Vector(Vec<Gc<Value<C>>>, C::ValueMeta)

A fixed-length collection with O(1) lookup.

Implementations

impl<C: 'static + Context> Value<C>

pub fn bool(b: bool) -> Gc<Value<C>>

A pseudo-constructor that converts a bool to a Value.

pub fn improper_list<II: IntoIterator<Item = Gc<Value<C>>>>( iter: II, last: Gc<Value<C>>, meta: C::ValueMeta, ) -> Gc<Value<C>>

Converts an Iterator and a last element to an improper cons-list.

pub fn list<II: IntoIterator<Item = Gc<Value<C>>>>( iter: II, meta: C::ValueMeta, ) -> Gc<Value<C>>

Converts an Iterator to a cons-list.

pub fn meta(&self) -> C::ValueMeta

Extracts the metadata from a Value.

pub fn ordering(o: Option<CmpOrdering>) -> Gc<Value<C>>

Converts an ordering to a Value.

pub fn transmute_with<C2, F>(&self, f: &F) -> Option<Value<C2>>

where C2: 'static + Context, F: Fn(&C::ValueMeta) -> Option<C2::ValueMeta>,

Converts a Value between Contexts.

Will fail to transmute functions and objects.

pub fn transmute_data<C2: 'static + Context>(&self) -> Option<Value<C2>>

Converts a Value between Contexts.

Will fail to transmute functions and objects. Any metadata will be discarded, with the default for the destination being used. To preserve metadata, use transmute_with instead.

pub fn vector<II: IntoIterator<Item = Gc<Value<C>>>>(iter: II) -> Gc<Value<C>>

Converts an Iterator to a vector.

Trait Implementations

impl<C: 'static + Context> Clone for Value<C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: 'static + Context> Debug for Value<C>

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

Formats the value using the given formatter.

impl<C: 'static + Context> Display for Value<C>

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

Formats the value using the given formatter.

impl<C: 'static + Context> Drop for Value<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: 'static + Context> Finalize for Value<C>

fn finalize(&self)

impl<C: 'static + Context> PartialEq for Value<C>

fn eq(&self, other: &Self) -> 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<C: 'static + Context> PartialOrd for Value<C>

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

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<C: 'static + Context> Trace for Value<C>

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn root(&self)

Increments the root-count of all contained Gcs.

unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs.

fn finalize_glue(&self)

Runs Finalize::finalize() on this object and all contained subobjects