Skip to main content

FunctionLibrary

Struct FunctionLibrary 

Source
pub struct FunctionLibrary { /* private fields */ }
Expand description

Registry of named functions available to expression evaluation.

Built-in functions (round, dice, random_range, …) are pre-registered. Hosts can add their own via FunctionLibrary::register.

Implementations§

Source§

impl FunctionLibrary

Source

pub fn new() -> Self

Creates a library with the built-in functions pre-registered.

Source

pub fn register<F>(&mut self, name: impl Into<String>, f: F)
where F: Fn(Vec<Value>) -> Result<Value> + Send + Sync + 'static,

Registers a named function.

Replaces any existing function with the same name.

Source

pub fn call(&self, name: &str, args: Vec<Value>) -> Result<Value>

Calls the function named name with args, or returns an error if not found.

§Errors

Returns DialogueError::Function if the function is unknown or the call fails.

Trait Implementations§

Source§

impl Debug for FunctionLibrary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FunctionLibrary

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.