Struct rhai::FnPtr[−][src]

pub struct FnPtr(_, _);

Expand description

A general function pointer, which may carry additional (i.e. curried) argument values to be passed onto a function during a call.

Implementations

[src]

impl FnPtr

[src]

pub fn fn_name(&self) -> &str

Get the name of the function.

[src]

pub fn curry(&self) -> &[Dynamic ]ⓘ
Notable traits for &'_ mut [u8 ]
`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Get the curried arguments.

[src]

pub fn call_dynamic(
 &self,
 engine: &Engine,
 lib: impl AsRef<Module>,
 this_ptr: Option<&mut Dynamic>,
 arg_values: impl AsMut<[Dynamic ]>
) -> Result<Dynamic, Box<EvalAltResult>>

Call the function pointer with curried arguments (if any).

If this function is a script-defined function, it must not be marked private.

All the arguments are consumed, meaning that they’re replaced by (). This is to avoid unnecessarily cloning the arguments. Do not use the arguments after this call. If they are needed afterwards, clone them before calling this function.

Trait Implementations

[src]

impl Clone for FnPtr

[src]

fn clone(&self) -> FnPtr

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for FnPtr

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Default for FnPtr

[src]

fn default() -> FnPtr

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

[src]

impl Display for FnPtr

[src]

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

Formats the value using the given formatter. Read more

[src]

impl From<FnPtr> for Dynamic

[src]

fn from(value: FnPtr) -> Self

Performs the conversion.

[src]

impl TryFrom<&'_ str> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

[src]

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

[src]

impl TryFrom<ImmutableString> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

[src]

fn try_from(value: ImmutableString) -> Result<Self, Self::Error>

Performs the conversion.

[src]

impl TryFrom<String> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

[src]

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for FnPtr

impl !Send for FnPtr

impl !Sync for FnPtr

impl Unpin for FnPtr

impl !UnwindSafe for FnPtr

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T> ToString for T where
T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct rhai::FnPtr[−][src]

Implementations

impl FnPtr

pub fn fn_name(&self) -> &str

pub fn curry(&self) -> &[Dynamic]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

pub fn call_dynamic( &self, engine: &Engine, lib: impl AsRef<Module>, this_ptr: Option<&mut Dynamic>, arg_values: impl AsMut<[Dynamic]>) -> Result<Dynamic, Box<EvalAltResult>>

WARNING

Trait Implementations

impl Clone for FnPtr

fn clone(&self) -> FnPtr

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

impl Debug for FnPtr

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

impl Default for FnPtr

fn default() -> FnPtr

impl Display for FnPtr

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

impl From<FnPtr> for Dynamic

fn from(value: FnPtr) -> Self

impl TryFrom<&'_ str> for FnPtr

type Error = Box<EvalAltResult>

fn try_from(value: &str) -> Result<Self, Self::Error>

impl TryFrom<ImmutableString> for FnPtr

type Error = Box<EvalAltResult>

fn try_from(value: ImmutableString) -> Result<Self, Self::Error>

impl TryFrom<String> for FnPtr

type Error = Box<EvalAltResult>

fn try_from(value: String) -> Result<Self, Self::Error>

Auto Trait Implementations

impl !RefUnwindSafe for FnPtr

impl !Send for FnPtr

impl !Sync for FnPtr

impl Unpin for FnPtr

impl !UnwindSafe for FnPtr

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

pub fn curry(&self) -> &[Dynamic ]ⓘ
Notable traits for &'_ mut [u8 ]
`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

pub fn call_dynamic(
&self,
engine: &Engine,
lib: impl AsRef<Module>,
this_ptr: Option<&mut Dynamic>,
arg_values: impl AsMut<[Dynamic ]>
) -> Result<Dynamic, Box<EvalAltResult>>

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

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

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