Enum ketos::value::Value

pub enum Value {
    Unit,
    Unbound,
    Bool(bool),
    Float(f64),
    Integer(Integer),
    Ratio(Ratio),
    Struct(Rc<Struct>),
    StructDef(Rc<StructDef>),
    Name(Name),
    Keyword(Name),
    Char(char),
    String(RcString),
    Bytes(Bytes),
    Path(PathBuf),
    Quasiquote(Box<Value>, u32),
    Comma(Box<Value>, u32),
    CommaAt(Box<Value>, u32),
    Quote(Box<Value>, u32),
    List(RcVec<Value>),
    Function(Function),
    Lambda(Lambda),
    Foreign(Rc<dyn ForeignValue>),
}

Represents a value.

Variants

Unit

()

Unbound

Placeholder for missing optional values; should not be used to represent any real value.

Bool(bool)

Boolean -- true or false

Float(f64)

Floating point number

Integer(Integer)

Signed arbitrary precision integer

Ratio(Ratio)

Arbitrary precision ratio

Struct(Rc<Struct>)

Struct value

StructDef(Rc<StructDef>)

Struct definition

Name(Name)

Literal name

Keyword(Name)

Keyword

Char(char)

Character

String(RcString)

String

Bytes(Bytes)

Byte string

Path(PathBuf)

Path

Quasiquote(Box<Value>, u32)

Quasiquoted value; quote depth MUST NEVER be zero.

Comma(Box<Value>, u32)

Comma'd value; comma depth MUST NEVER be zero.

CommaAt(Box<Value>, u32)

Comma-at'd value; quote depth MUST NEVER be zero.

Quote(Box<Value>, u32)

Quoted value; quote depth MUST NEVER be zero.

List(RcVec<Value>)

Series of one or more values. MUST NEVER be of length zero. Use Unit to represent empty lists.

Function(Function)

Function implemented in Rust

Lambda(Lambda)

Compiled bytecode function

Foreign(Rc<dyn ForeignValue>)

Boxed value of a foreign type

Methods

impl Value

pub fn new_foreign<T: ForeignValue>(t: T) -> Value

Returns a value of a foreign type.

pub fn new_foreign_fn<F>(name: Name, f: F) -> Value where
    F: Any + Fn(&Context, &mut [Value]) -> Result<Value, Error>, 

Returns a value containing a foreign function.

pub fn compare(&self, rhs: &Value) -> Result<Ordering, ExecError>

Compares two values; returns an error if the values cannot be compared.

pub fn is_equal(&self, rhs: &Value) -> Result<bool, ExecError>

Tests two values for equality; returns an error if the values cannot be compared.

pub fn is_identical(&self, rhs: &Value) -> bool

Returns whether this value is identical to another. The notable difference between this and eq is that float NaN values will compare equal.

pub fn take(&mut self) -> Value

Replaces the value with Unit and returns the old value.

pub fn quasiquote(self, n: u32) -> Value

Returns the value, quasi-quoted.

Panics

If n would overflow.

pub fn comma(self, n: u32) -> Value

Returns the value, comma'd.

Panics

If n would overflow.

pub fn comma_at(self, n: u32) -> Value

Returns the value, comma-at'd.

Panics

If n would overflow.

pub fn quote(self, n: u32) -> Value

Returns the value, quoted.

Panics

If n would overflow.

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

Returns a string describing the type of the value.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy 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<'a, T: Clone + Into<Value>> From<&'a [T]> for Value

fn from(v: &[T]) -> Value

Performs the conversion.

impl<'a> From<&'a OsStr> for Value

fn from(s: &OsStr) -> Value

Performs the conversion.

impl<'a> From<&'a Path> for Value

fn from(s: &Path) -> Value

Performs the conversion.

impl<'a, T: Clone + Into<Value>> From<&'a mut [T]> for Value

fn from(v: &mut [T]) -> Value

Performs the conversion.

impl<'a> From<&'a str> for Value

fn from(s: &str) -> Value

Performs the conversion.

impl From<()> for Value

fn from(_: ()) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>, K: Into<Value>, L: Into<Value>> From<(A, B, C, D, E, F, G, H, I, J, K, L)> for Value

fn from(v: (A, B, C, D, E, F, G, H, I, J, K, L)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>, K: Into<Value>> From<(A, B, C, D, E, F, G, H, I, J, K)> for Value

fn from(v: (A, B, C, D, E, F, G, H, I, J, K)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>, J: Into<Value>> From<(A, B, C, D, E, F, G, H, I, J)> for Value

fn from(v: (A, B, C, D, E, F, G, H, I, J)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>, I: Into<Value>> From<(A, B, C, D, E, F, G, H, I)> for Value

fn from(v: (A, B, C, D, E, F, G, H, I)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>, H: Into<Value>> From<(A, B, C, D, E, F, G, H)> for Value

fn from(v: (A, B, C, D, E, F, G, H)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>, G: Into<Value>> From<(A, B, C, D, E, F, G)> for Value

fn from(v: (A, B, C, D, E, F, G)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>, F: Into<Value>> From<(A, B, C, D, E, F)> for Value

fn from(v: (A, B, C, D, E, F)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>, E: Into<Value>> From<(A, B, C, D, E)> for Value

fn from(v: (A, B, C, D, E)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>, D: Into<Value>> From<(A, B, C, D)> for Value

fn from(v: (A, B, C, D)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>, C: Into<Value>> From<(A, B, C)> for Value

fn from(v: (A, B, C)) -> Value

Performs the conversion.

impl<A: Into<Value>, B: Into<Value>> From<(A, B)> for Value

fn from(v: (A, B)) -> Value

Performs the conversion.

impl<A: Into<Value>> From<(A,)> for Value

fn from(v: (A,)) -> Value

Performs the conversion.

impl From<Bytes> for Value

fn from(s: Bytes) -> Value

Performs the conversion.

impl From<Integer> for Value

fn from(i: Integer) -> Value

Performs the conversion.

impl<T: Into<Value>> From<Option<T>> for Value

fn from(v: Option<T>) -> Value

Performs the conversion.

impl From<OsString> for Value

fn from(s: OsString) -> Value

Performs the conversion.

impl From<PathBuf> for Value

fn from(p: PathBuf) -> Value

Performs the conversion.

impl From<Ratio> for Value

fn from(r: Ratio) -> Value

Performs the conversion.

impl From<RcString> for Value

fn from(s: RcString) -> Value

Performs the conversion.

impl From<RcVec<Value>> for Value

fn from(v: RcVec<Value>) -> Value

Performs the conversion.

impl From<String> for Value

fn from(s: String) -> Value

Performs the conversion.

impl<T: Into<Value>> From<Vec<T>> for Value

fn from(v: Vec<T>) -> Value

Performs the conversion.

impl From<bool> for Value

fn from(b: bool) -> Value

Performs the conversion.

impl From<char> for Value

fn from(c: char) -> Value

Performs the conversion.

impl From<f32> for Value

fn from(f: f32) -> Value

Performs the conversion.

impl From<f64> for Value

fn from(f: f64) -> Value

Performs the conversion.

impl From<i16> for Value

fn from(i: i16) -> Value

Performs the conversion.

impl From<i32> for Value

fn from(i: i32) -> Value

Performs the conversion.

impl From<i64> for Value

fn from(i: i64) -> Value

Performs the conversion.

impl From<i8> for Value

fn from(i: i8) -> Value

Performs the conversion.

impl From<isize> for Value

fn from(i: isize) -> Value

Performs the conversion.

impl From<u16> for Value

fn from(i: u16) -> Value

Performs the conversion.

impl From<u32> for Value

fn from(i: u32) -> Value

Performs the conversion.

impl From<u64> for Value

fn from(i: u64) -> Value

Performs the conversion.

impl From<u8> for Value

fn from(i: u8) -> Value

Performs the conversion.

impl From<usize> for Value

fn from(i: usize) -> Value

Performs the conversion.

impl FromValue for Value

fn from_value(v: Value) -> Result<Value, ExecError>

Consumes the Value and returns a Rust value

impl<'a> FromValueRef<'a> for &'a Value

fn from_value_ref(v: &'a Value) -> Result<&'a Value, ExecError>

Returns the borrowed value

impl NameDebug for Value

fn fmt(&self, names: &NameStore, f: &mut Formatter) -> Result

Writes the value's debug representation to the formatter stream.

impl NameDisplay for Value

fn fmt(&self, names: &NameStore, f: &mut Formatter) -> Result

Writes the value's display representation to the formatter stream.