Struct NativeFunction

Source
pub struct NativeFunction<'a> {
    pub arity: usize,
    pub implementation: Rc<dyn Fn(&[Real]) -> Real>,
    pub name: Cow<'a, str>,
    pub description: Option<String>,
}
Expand description

Represents a native Rust function that can be registered with the evaluation context.

Native functions allow users to extend the expression evaluator with custom functionality written in Rust. These functions can be called from within expressions like any built-in function.

§Example

let mut ctx = EvalContext::new();

// Register a custom function that calculates the hypotenuse
ctx.register_native_function(
    "hypotenuse",     // Function name
    2,                // Takes 2 arguments
    |args: &[Real]| { // Implementation
        (args[0] * args[0] + args[1] * args[1]).sqrt()
    }
);

// Use the function in an expression
let result = interp("hypotenuse(3, 4)", Some(Rc::new(ctx))).unwrap();
assert_eq!(result, 5.0);

Fields§

§arity: usize

Number of arguments the function takes.

§implementation: Rc<dyn Fn(&[Real]) -> Real>

The actual implementation of the function as a Rust closure.

§name: Cow<'a, str>

The name of the function as it will be used in expressions.

§description: Option<String>

Optional description of what the function does.

Trait Implementations§

Source§

impl<'a> Clone for NativeFunction<'a>

Source§

fn clone(&self) -> NativeFunction<'a>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for NativeFunction<'a>

§

impl<'a> !RefUnwindSafe for NativeFunction<'a>

§

impl<'a> !Send for NativeFunction<'a>

§

impl<'a> !Sync for NativeFunction<'a>

§

impl<'a> Unpin for NativeFunction<'a>

§

impl<'a> !UnwindSafe for NativeFunction<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.