Struct ralik::Context

pub struct Context(_);

The Context stores all types, free functions and global variables.

While it can be customized to a large extent, it is suggested to start with the default context, which contains working types for the core types:

let context = Context::new();

The default context can then be extended for the specific use case:

// Define a global variable `$` of the Unit type `()`
context.insert_variable("$", Value::new_unit(&context).unwrap());

When starting with an empty context, the core types are not available by default:

let context = Context::new_empty();
Value::new_bool(&context, true).unwrap_err();

Implementations

impl Context

pub fn get_function(
    &self,
    key: &str
) -> Option<fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>>

pub fn insert_function(
    &self,
    key: impl Into<String>,
    value: fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>
) -> Option<fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>>

pub fn remove_function(
    &self,
    key: &str
) -> Option<(String, fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>)>

impl Context

pub fn get_macro(
    &self,
    key: &str
) -> Option<fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>>

pub fn insert_macro(
    &self,
    key: impl Into<String>,
    value: fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>
) -> Option<fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>>

pub fn remove_macro(
    &self,
    key: &str
) -> Option<(String, fn(_: &Context, _: &[Value]) -> Result<Value, RuntimeError>)>

impl Context

pub fn get_type(&self, key: impl AsRef<str>) -> Option<TypeHandle>

pub fn get_unit_type(&self) -> Result<TypeHandle, InvalidTupleType>

pub fn get_bool_type(&self) -> Result<TypeHandle, InvalidBoolType>

pub fn get_char_type(&self) -> Result<TypeHandle, InvalidCharType>

pub fn get_integer_type(&self) -> Result<TypeHandle, InvalidIntegerType>

pub fn get_string_type(&self) -> Result<TypeHandle, InvalidStringType>

pub fn get_tuple_type(
    &self,
    element_type_names: impl Iterator<Item = impl AsRef<str> + Debug> + Clone
) -> Result<TypeHandle, InvalidTupleType>

pub fn get_array_type(
    &self,
    element_type_name: &str
) -> Result<TypeHandle, InvalidArrayType>

pub fn get_option_type(
    &self,
    element_type_name: &str
) -> Result<TypeHandle, InvalidArrayType>

pub fn insert_type(&self, value: impl Type + 'static) -> TypeHandle

impl Context

pub fn get_variable(&self, key: &str) -> Option<Value>

pub fn insert_variable(
    &self,
    key: impl Into<String>,
    value: impl Into<Value>
) -> Option<Value>

pub fn remove_variable(&self, key: &str) -> Option<(String, Value)>

impl Context

pub fn new() -> Self

pub fn new_empty() -> Self

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the "default value" for a type.