Function

Struct Function 

Source
pub struct Function<'host> { /* private fields */ }
Expand description

An function which is callable by espy or its host.

This differs from Program in that it may accept an argument; use Function::pipe or Function::piped to provide one, and Function::eval to evaluate the function.

To instead provide a Rust function to espy, use Function::borrow or Function::owned with the ExternFn and ExternFnOwned traits, respectively.

Implementations§

Source§

impl<'host> Function<'host>

Source

pub fn borrow(external: &'host dyn ExternFn) -> Function<'host>

Source

pub fn owned(external: Rc<dyn ExternFnOwned>) -> Function<'host>

Source

pub fn to_static(&self) -> Option<StaticFunction>

Source

pub fn eval(self) -> Result<Value<'host>, Error>

§Errors

Returns an error if evaluating the function results in an error

Source

pub fn pipe(&mut self, argument: Value<'host>)

Concatentes the function’s argument list with argument.

Source

pub fn piped(self, argument: Value<'host>) -> Function<'host>

Trait Implementations§

Source§

impl<'host> Clone for Function<'host>

Source§

fn clone(&self) -> Function<'host>

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

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

Performs copy-assignment from source. Read more
Source§

impl<'host> Debug for Function<'host>

Source§

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

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

impl<'host> From<Function<'host>> for Value<'host>

Source§

fn from(f: Function<'host>) -> Value<'host>

Converts to this type from the input type.
Source§

impl<'host> From<FunctionAction<'host>> for Function<'host>

Source§

fn from(action: FunctionAction<'host>) -> Function<'host>

Converts to this type from the input type.
Source§

impl<'host, T> From<T> for Function<'host>

Source§

fn from(value: T) -> Function<'host>

Converts to this type from the input type.
Source§

impl<'host> TryFrom<Value<'host>> for Function<'host>

Source§

type Error = Error

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

fn try_from( value: Value<'host>, ) -> Result<Function<'host>, <Function<'host> as TryFrom<Value<'host>>>::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<'host> Freeze for Function<'host>

§

impl<'host> !RefUnwindSafe for Function<'host>

§

impl<'host> !Send for Function<'host>

§

impl<'host> !Sync for Function<'host>

§

impl<'host> Unpin for Function<'host>

§

impl<'host> !UnwindSafe for Function<'host>

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.