Enum glsp::Val

pub enum Val {
    Nil,
    Int(i32),
    Flo(f32),
    Char(char),
    Bool(bool),
    Sym(Sym),
    Arr(Root<Arr>),
    Str(Root<Str>),
    Tab(Root<Tab>),
    GIter(Root<GIter>),
    Obj(Root<Obj>),
    Class(Root<Class>),
    GFn(Root<GFn>),
    Coro(Root<Coro>),
    RData(Root<RData>),
    RFn(Root<RFn>),
}

Any GameLisp value.

Many functions in this crate provide automatic conversions to and from Val, using the FromVal and IntoVal traits.

Variants

Nil

Int(i32)

Flo(f32)

Char(char)

Bool(bool)

Sym(Sym)

Arr(Root<Arr>)

Str(Root<Str>)

Tab(Root<Tab>)

GIter(Root<GIter>)

Obj(Root<Obj>)

Class(Root<Class>)

GFn(Root<GFn>)

Coro(Root<Coro>)

RData(Root<RData>)

RFn(Root<RFn>)

Implementations

impl Val

pub fn is_nil(&self) -> bool

pub fn is_truthy(&self) -> bool

Returns true if the value is anything other than #n or #f.

pub fn is_falsy(&self) -> bool

Returns true if the value is #n or #f.

pub fn is_num(&self) -> bool

Returns true if the value belongs to the num abstract type (int or flo).

pub fn is_deque(&self) -> bool

Returns true if the value belongs to the deque abstract type (arr or str).

pub fn is_callable(&self) -> bool

Returns true if the value belongs to the callable abstract type (fn, rfn or class).

pub fn is_expander(&self) -> bool

Returns true if the value belongs to the expander abstract type (fn or rfn).

pub fn is_iterable(&self) -> bool

Returns true if the value belongs to the iterable abstract type (arr, str, tab, iter or coro).

pub fn shallow_clone(&self) -> Result<Val, GError>

Creates a shallow copy of the value.

Equivalent to (clone val).

pub fn deep_clone(&self) -> Result<Val, GError>

Recursively copies the value and all of its contents.

Equivalent to (deep-clone val).

pub fn freeze(&self)

Makes the value immutable.

Equivalent to (freeze! val).

pub fn deep_freeze(&self)

Makes the value and all of its contents immutable.

Equivalent to (deep-freeze! val).

impl Val

pub fn num_eq(&self, other: &Val) -> Option<bool>

Equivalent to (== self other).

pub fn same(&self, other: &Val) -> bool

Equivalent to (same? self other).

pub fn keys_eqv(&self, other: &Val) -> bool

Equivalent to (keys-eqv? self other).

pub fn try_eq(&self, other: &Val) -> Result<bool, GError>

Equivalent to (eq? self other).

Note that, because this method may need to invoke an op-eq? method when both of its arguments are objects or RData, it can potentially fail.

The same is true for PartialEq and Eq comparisons between values - for example, using Rust's == operator. If those comparisons encounter a GameLisp error, they will panic.

impl Val

pub fn downgrade(&self) -> GcVal

Constructs a GcVal based on this Val.

impl Val

pub fn is_representable(&self) -> bool

Returns true if this value can be losslessly converted to text.

pub fn check_representability(&self) -> Result<(), &'static str>

Returns Ok if this value can be losslessly converted to text.

pub fn is_serializable(&self) -> bool

Returns true if this value can be serialized and deserialized using Serde.

This method is only present when the "serde" feature is enabled.

pub fn check_serializability(&self) -> Result<(), &'static str>

Returns Ok if this value can be serialized and deserialized using Serde.

This method is only present when the "serde" feature is enabled.

impl Val

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

Returns the name of this value's primitive type, such as "nil" or "fn".

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

Returns the name of this value's primitive type, prefixed with the indefinite article, such as "an arr" or "a fn".

match val {
	Val::Int(_) => (),
	_ => bail!("expected an int, received {}", val.a_type_name())
}

impl Val

pub fn is_int(&self) -> bool

pub fn unwrap_int(self) -> i32

pub fn is_flo(&self) -> bool

pub fn unwrap_flo(self) -> f32

pub fn is_char(&self) -> bool

pub fn unwrap_char(self) -> char

pub fn is_bool(&self) -> bool

pub fn unwrap_bool(self) -> bool

pub fn is_sym(&self) -> bool

pub fn unwrap_sym(self) -> Sym

pub fn is_arr(&self) -> bool

pub fn unwrap_arr(self) -> Root<Arr>

pub fn is_str(&self) -> bool

pub fn unwrap_str(self) -> Root<Str>

pub fn is_tab(&self) -> bool

pub fn unwrap_tab(self) -> Root<Tab>

pub fn is_giter(&self) -> bool

pub fn unwrap_giter(self) -> Root<GIter>

pub fn is_obj(&self) -> bool

pub fn unwrap_obj(self) -> Root<Obj>

pub fn is_class(&self) -> bool

pub fn unwrap_class(self) -> Root<Class>

pub fn is_gfn(&self) -> bool

pub fn unwrap_gfn(self) -> Root<GFn>

pub fn is_coro(&self) -> bool

pub fn unwrap_coro(self) -> Root<Coro>

pub fn is_rdata(&self) -> bool

pub fn unwrap_rdata(self) -> Root<RData>

pub fn is_rfn(&self) -> bool

pub fn unwrap_rfn(self) -> Root<RFn>

Trait Implementations

impl Clone for Val

pub fn clone(&self) -> Val

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Val

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

Formats the value using the given formatter.

impl Default for Val

pub fn default() -> Val

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Val

pub fn deserialize<D>(d: D) -> Result<Val, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Val

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

Formats the value using the given formatter.

impl Eq for Val

impl FromElement<char> for Val

pub fn from_element(item: &char) -> Result<Val, GError>

impl FromVal for Val

pub fn from_val(val: &Val) -> Result<Val, GError>

impl<'_> IntoElement<char> for &'_ Val

pub fn into_element(self) -> Result<char, GError>

impl<'_> IntoElement<char> for &'_ mut Val

pub fn into_element(self) -> Result<char, GError>

impl IntoElement<char> for Val

pub fn into_element(self) -> Result<char, GError>

impl<'a> IntoVal for &'a Val

pub fn into_val(self) -> Result<Val, GError>

impl<'a> IntoVal for &'a mut Val

pub fn into_val(self) -> Result<Val, GError>

impl IntoVal for Val

pub fn into_val(self) -> Result<Val, GError>

impl PartialEq<Val> for Val

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Val> for Val

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Serialize for Val

pub fn serialize<S>(
    &self,
    s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Splay for Val

pub fn splay(&self, dst: &Arr) -> Result<(), GError>