Enum knightrs::Value

pub enum Value {
    Null,
    Boolean(Boolean),
    Number(Number),
    Text(Text),
    Variable(Variable),
    Function(Function, Rc<[Value]>),
}

Variants

Null

Boolean(Boolean)

Number(Number)

Text(Text)

Variable(Variable)

Function(Function, Rc<[Value]>)

Implementations

impl Value

pub fn run(&self, env: &mut Environment<'_, '_, '_>) -> Result<Self, Error>

#[must_use = "getting the type name by itself does nothing."]

pub const fn typename(&self) -> &'static str

pub fn to_boolean(&self) -> Result<Boolean, Error>

pub fn to_number(&self) -> Result<Number, Error>

pub fn to_text(&self) -> Result<Text, Error>

impl Value

pub fn parse_str<S: AsRef<str>>(
    input: S,
    env: &mut Environment<'_, '_, '_>
) -> Result<Self, ParseError>

Parses out a stream from the given input within the context of env.

This function simply calls [parse] with a char iterator over input; see it for more details.

Errors

This function returns any errors that [parse] returns.

pub fn parse<S: IntoIterator<Item = char>>(
    input: S,
    env: &mut Environment<'_, '_, '_>
) -> Result<Self, ParseError>

Parses out a stream from the given input within the context of env.

Note: Yes, technically this could be an iterator over u8, as the Knight specs clearly state that all source bytes are a subset of ASCII. However, we may want to support fun stuff like non-ASCII variables as an optional extension in the future. As such, char is required.

Errors

This function returns any errors that occur whilst parsing; See ParseError’s variants for what conditions can cause errors.

See Also

Section 1. within the Knight specs for parsing.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

pub 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 Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Value

impl From<Text> for Value

fn from(text: Text) -> Self

Performs the conversion.

impl From<Variable> for Value

fn from(variable: Variable) -> Self

Performs the conversion.

impl From<bool> for Value

fn from(boolean: Boolean) -> Self

Performs the conversion.

impl From<i64> for Value

fn from(number: Number) -> Self

Performs the conversion.

impl PartialEq<Value> for Value

fn eq(&self, rhs: &Self) -> 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 TryFrom<&'_ Value> for Boolean

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Text

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<&'_ Value> for Number

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Error>

Performs the conversion.