[−][src]Trait rhai::RegisterFn

pub trait RegisterFn<FN, ARGS, RET> {
    fn register_fn(&mut self, name: &str, f: FN) -> &mut Selfⓘ
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,     type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,     type Item = <I as Iterator>::Item;
;
}

Trait to register custom functions with the Engine.

Required methods

fn register_fn(&mut self, name: &str, f: FN) -> &mut Selfⓘ

Notable traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

Register a custom function with the Engine.

Example

use rhai::{Engine, RegisterFn};

// Normal function
fn add(x: i64, y: i64) -> i64 {
    x + y
}

let mut engine = Engine::new();

// You must use the trait rhai::RegisterFn to get this method.
engine.register_fn("add", add);

assert_eq!(engine.eval::<i64>("add(40, 2)")?, 42);

// You can also register a closure.
engine.register_fn("sub", |x: i64, y: i64| x - y );

assert_eq!(engine.eval::<i64>("sub(44, 2)")?, 42);
Loading content...

Implementors

impl<A: Variant + Clone, B: Variant + Clone, C: Variant + Clone, D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut A, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<A>, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<A: Variant + Clone, B: Variant + Clone, C: Variant + Clone, D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(A, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (A, B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<B: Variant + Clone, C: Variant + Clone, D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<B>, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<B: Variant + Clone, C: Variant + Clone, D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (B, C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<C: Variant + Clone, D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<C>, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<C: Variant + Clone, D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (C, D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<D>, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<D: Variant + Clone, E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (D, E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<E>, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<E: Variant + Clone, F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (E, F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<F>, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<F: Variant + Clone, G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (F, G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<FN: Fn() -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (), RET> for Engine[src]

impl<G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<G>, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<G: Variant + Clone, H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(G, H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (G, H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<H>, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<H: Variant + Clone, J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(H, J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (H, J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<J>, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<J: Variant + Clone, K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(J, K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (J, K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<K>, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<K: Variant + Clone, L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(K, L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (K, L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<L>, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<L: Variant + Clone, M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(L, M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (L, M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<M>, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<M: Variant + Clone, N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(M, N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (M, N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<N>, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<N: Variant + Clone, P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(N, P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (N, P, Q, R, S, T, U, V), RET> for Engine[src]

impl<P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<P>, Q, R, S, T, U, V), RET> for Engine[src]

impl<P: Variant + Clone, Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(P, Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (P, Q, R, S, T, U, V), RET> for Engine[src]

impl<Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<Q>, R, S, T, U, V), RET> for Engine[src]

impl<Q: Variant + Clone, R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(Q, R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Q, R, S, T, U, V), RET> for Engine[src]

impl<R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<R>, S, T, U, V), RET> for Engine[src]

impl<R: Variant + Clone, S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(R, S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (R, S, T, U, V), RET> for Engine[src]

impl<S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<S>, T, U, V), RET> for Engine[src]

impl<S: Variant + Clone, T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(S, T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (S, T, U, V), RET> for Engine[src]

impl<T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<T>, U, V), RET> for Engine[src]

impl<T: Variant + Clone, U: Variant + Clone, V: Variant + Clone, FN: Fn(T, U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (T, U, V), RET> for Engine[src]

impl<U: Variant + Clone, V: Variant + Clone, FN: Fn(&mut U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<U>, V), RET> for Engine[src]

impl<U: Variant + Clone, V: Variant + Clone, FN: Fn(U, V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (U, V), RET> for Engine[src]

impl<V: Variant + Clone, FN: Fn(&mut V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (Mut<V>,), RET> for Engine[src]

impl<V: Variant + Clone, FN: Fn(V) -> RET + SendSync + 'static, RET: Variant + Clone> RegisterFn<FN, (V,), RET> for Engine[src]

Loading content...