680 lines
21 KiB
Rust
680 lines
21 KiB
Rust
//! Module defining interfaces to native-Rust functions.
|
|
|
|
use crate::ast::{FnAccess, ScriptFnDef};
|
|
use crate::engine::Imports;
|
|
use crate::plugin::PluginFunction;
|
|
use crate::stdlib::{
|
|
boxed::Box,
|
|
convert::{TryFrom, TryInto},
|
|
fmt,
|
|
iter::empty,
|
|
mem,
|
|
string::String,
|
|
};
|
|
use crate::token::is_valid_identifier;
|
|
use crate::{
|
|
calc_script_fn_hash, Dynamic, Engine, EvalAltResult, EvalContext, ImmutableString, Module,
|
|
Position, StaticVec,
|
|
};
|
|
|
|
#[cfg(not(feature = "sync"))]
|
|
use crate::stdlib::rc::Rc;
|
|
#[cfg(feature = "sync")]
|
|
use crate::stdlib::sync::Arc;
|
|
|
|
/// Trait that maps to `Send + Sync` only under the `sync` feature.
|
|
#[cfg(feature = "sync")]
|
|
pub trait SendSync: Send + Sync {}
|
|
/// Trait that maps to `Send + Sync` only under the `sync` feature.
|
|
#[cfg(feature = "sync")]
|
|
impl<T: Send + Sync> SendSync for T {}
|
|
|
|
/// Trait that maps to `Send + Sync` only under the `sync` feature.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub trait SendSync {}
|
|
/// Trait that maps to `Send + Sync` only under the `sync` feature.
|
|
#[cfg(not(feature = "sync"))]
|
|
impl<T> SendSync for T {}
|
|
|
|
/// Immutable reference-counted container.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type Shared<T> = Rc<T>;
|
|
/// Immutable reference-counted container.
|
|
#[cfg(feature = "sync")]
|
|
pub type Shared<T> = Arc<T>;
|
|
|
|
/// Synchronized shared object.
|
|
#[cfg(not(feature = "no_closure"))]
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type Locked<T> = crate::stdlib::cell::RefCell<T>;
|
|
/// Synchronized shared object.
|
|
#[cfg(not(feature = "no_closure"))]
|
|
#[cfg(feature = "sync")]
|
|
pub type Locked<T> = crate::stdlib::sync::RwLock<T>;
|
|
|
|
/// Context of a native Rust function call.
|
|
#[derive(Debug, Copy, Clone)]
|
|
pub struct NativeCallContext<'e, 's, 'a, 'm, 'pm: 'm> {
|
|
engine: &'e Engine,
|
|
source: Option<&'s str>,
|
|
pub(crate) mods: Option<&'a Imports>,
|
|
pub(crate) lib: &'m [&'pm Module],
|
|
}
|
|
|
|
impl<'e, 's, 'a, 'm, 'pm: 'm, M: AsRef<[&'pm Module]> + ?Sized>
|
|
From<(&'e Engine, &'s Option<ImmutableString>, &'a Imports, &'m M)>
|
|
for NativeCallContext<'e, 's, 'a, 'm, 'pm>
|
|
{
|
|
#[inline(always)]
|
|
fn from(value: (&'e Engine, &'s Option<ImmutableString>, &'a Imports, &'m M)) -> Self {
|
|
Self {
|
|
engine: value.0,
|
|
source: value.1.as_ref().map(|s| s.as_str()),
|
|
mods: Some(value.2),
|
|
lib: value.3.as_ref(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'e, 'm, 'pm: 'm, M: AsRef<[&'pm Module]> + ?Sized> From<(&'e Engine, &'m M)>
|
|
for NativeCallContext<'e, '_, '_, 'm, 'pm>
|
|
{
|
|
#[inline(always)]
|
|
fn from(value: (&'e Engine, &'m M)) -> Self {
|
|
Self {
|
|
engine: value.0,
|
|
source: None,
|
|
mods: None,
|
|
lib: value.1.as_ref(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'e, 's, 'a, 'm, 'pm> NativeCallContext<'e, 's, 'a, 'm, 'pm> {
|
|
/// Create a new [`NativeCallContext`].
|
|
#[inline(always)]
|
|
pub fn new(engine: &'e Engine, lib: &'m impl AsRef<[&'pm Module]>) -> Self {
|
|
Self {
|
|
engine,
|
|
source: None,
|
|
mods: None,
|
|
lib: lib.as_ref(),
|
|
}
|
|
}
|
|
/// _(INTERNALS)_ Create a new [`NativeCallContext`].
|
|
/// Available under the `internals` feature only.
|
|
#[cfg(feature = "internals")]
|
|
#[cfg(not(feature = "no_module"))]
|
|
#[inline(always)]
|
|
pub fn new_with_all_fields(
|
|
engine: &'e Engine,
|
|
source: &'s Option<ImmutableString>,
|
|
imports: &'a mut Imports,
|
|
lib: &'m impl AsRef<[&'pm Module]>,
|
|
) -> Self {
|
|
Self {
|
|
engine,
|
|
source: source.as_ref().map(|s| s.as_str()),
|
|
mods: Some(imports),
|
|
lib: lib.as_ref(),
|
|
}
|
|
}
|
|
/// The current [`Engine`].
|
|
#[inline(always)]
|
|
pub fn engine(&self) -> &Engine {
|
|
self.engine
|
|
}
|
|
/// The current source.
|
|
#[inline(always)]
|
|
pub fn source(&self) -> Option<&str> {
|
|
self.source
|
|
}
|
|
/// Get an iterator over the current set of modules imported via `import` statements.
|
|
#[cfg(not(feature = "no_module"))]
|
|
#[inline(always)]
|
|
pub fn iter_imports(&self) -> impl Iterator<Item = (&str, &Module)> {
|
|
self.mods.iter().flat_map(|m| m.iter())
|
|
}
|
|
/// _(INTERNALS)_ The current set of modules imported via `import` statements.
|
|
/// Available under the `internals` feature only.
|
|
#[cfg(feature = "internals")]
|
|
#[cfg(not(feature = "no_module"))]
|
|
#[inline(always)]
|
|
pub fn imports(&self) -> Option<&Imports> {
|
|
self.mods
|
|
}
|
|
/// Get an iterator over the namespaces containing definitions of all script-defined functions.
|
|
#[inline(always)]
|
|
pub fn iter_namespaces(&self) -> impl Iterator<Item = &Module> {
|
|
self.lib.iter().cloned()
|
|
}
|
|
/// _(INTERNALS)_ The current set of namespaces containing definitions of all script-defined functions.
|
|
/// Available under the `internals` feature only.
|
|
#[cfg(feature = "internals")]
|
|
#[inline(always)]
|
|
pub fn namespaces(&self) -> &[&Module] {
|
|
self.lib
|
|
}
|
|
/// Call a function inside the call context.
|
|
///
|
|
/// ## WARNING
|
|
///
|
|
/// All arguments may be _consumed_, meaning that they may be 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.
|
|
///
|
|
/// If `is_method` is [`true`], the first argument is assumed to be passed
|
|
/// by reference and is not consumed.
|
|
#[inline(always)]
|
|
pub fn call_fn_dynamic_raw(
|
|
&self,
|
|
fn_name: &str,
|
|
is_method: bool,
|
|
public_only: bool,
|
|
args: &mut [&mut Dynamic],
|
|
def_value: Option<&Dynamic>,
|
|
) -> Result<Dynamic, Box<EvalAltResult>> {
|
|
self.engine()
|
|
.exec_fn_call(
|
|
&mut self.mods.cloned().unwrap_or_default(),
|
|
&mut Default::default(),
|
|
self.lib,
|
|
fn_name,
|
|
calc_script_fn_hash(empty(), fn_name, args.len() - if is_method { 1 } else { 0 }),
|
|
args,
|
|
is_method,
|
|
is_method,
|
|
public_only,
|
|
Position::NONE,
|
|
None,
|
|
def_value,
|
|
0,
|
|
)
|
|
.map(|(r, _)| r)
|
|
}
|
|
}
|
|
|
|
/// Consume a [`Shared`] resource and return a mutable reference to the wrapped value.
|
|
/// If the resource is shared (i.e. has other outstanding references), a cloned copy is used.
|
|
#[inline(always)]
|
|
pub fn shared_make_mut<T: Clone>(value: &mut Shared<T>) -> &mut T {
|
|
#[cfg(not(feature = "sync"))]
|
|
return Rc::make_mut(value);
|
|
#[cfg(feature = "sync")]
|
|
return Arc::make_mut(value);
|
|
}
|
|
|
|
/// Consume a [`Shared`] resource if is unique (i.e. not shared), or clone it otherwise.
|
|
#[inline(always)]
|
|
pub fn shared_take_or_clone<T: Clone>(value: Shared<T>) -> T {
|
|
shared_try_take(value).unwrap_or_else(|v| v.as_ref().clone())
|
|
}
|
|
|
|
/// Consume a [`Shared`] resource if is unique (i.e. not shared).
|
|
#[inline(always)]
|
|
pub fn shared_try_take<T>(value: Shared<T>) -> Result<T, Shared<T>> {
|
|
#[cfg(not(feature = "sync"))]
|
|
return Rc::try_unwrap(value);
|
|
#[cfg(feature = "sync")]
|
|
return Arc::try_unwrap(value);
|
|
}
|
|
|
|
/// Consume a [`Shared`] resource, assuming that it is unique (i.e. not shared).
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if the resource is shared (i.e. has other outstanding references).
|
|
#[inline(always)]
|
|
pub fn shared_take<T>(value: Shared<T>) -> T {
|
|
shared_try_take(value).map_err(|_| ()).unwrap()
|
|
}
|
|
|
|
/// Arguments to a function call, which is a list of [`&mut Dynamic`][Dynamic].
|
|
pub type FnCallArgs<'a> = [&'a mut Dynamic];
|
|
|
|
/// A general function pointer, which may carry additional (i.e. curried) argument values
|
|
/// to be passed onto a function during a call.
|
|
#[derive(Debug, Clone)]
|
|
pub struct FnPtr(ImmutableString, StaticVec<Dynamic>);
|
|
|
|
impl FnPtr {
|
|
/// Create a new function pointer.
|
|
#[inline(always)]
|
|
pub fn new(name: impl Into<ImmutableString>) -> Result<Self, Box<EvalAltResult>> {
|
|
name.into().try_into()
|
|
}
|
|
/// Create a new function pointer without checking its parameters.
|
|
#[inline(always)]
|
|
pub(crate) fn new_unchecked(
|
|
name: impl Into<ImmutableString>,
|
|
curry: StaticVec<Dynamic>,
|
|
) -> Self {
|
|
Self(name.into(), curry)
|
|
}
|
|
/// Get the name of the function.
|
|
#[inline(always)]
|
|
pub fn fn_name(&self) -> &str {
|
|
self.get_fn_name().as_ref()
|
|
}
|
|
/// Get the name of the function.
|
|
#[inline(always)]
|
|
pub(crate) fn get_fn_name(&self) -> &ImmutableString {
|
|
&self.0
|
|
}
|
|
/// Get the underlying data of the function pointer.
|
|
#[inline(always)]
|
|
pub(crate) fn take_data(self) -> (ImmutableString, StaticVec<Dynamic>) {
|
|
(self.0, self.1)
|
|
}
|
|
/// Get the curried arguments.
|
|
#[inline(always)]
|
|
pub fn curry(&self) -> &[Dynamic] {
|
|
self.1.as_ref()
|
|
}
|
|
/// Add a new curried argument.
|
|
#[inline(always)]
|
|
pub fn add_curry(&mut self, value: Dynamic) -> &mut Self {
|
|
self.1.push(value);
|
|
self
|
|
}
|
|
/// Set curried arguments to the function pointer.
|
|
#[inline(always)]
|
|
pub fn set_curry(&mut self, values: impl IntoIterator<Item = Dynamic>) -> &mut Self {
|
|
self.1 = values.into_iter().collect();
|
|
self
|
|
}
|
|
/// Is the function pointer curried?
|
|
#[inline(always)]
|
|
pub fn is_curried(&self) -> bool {
|
|
!self.1.is_empty()
|
|
}
|
|
/// Does the function pointer refer to an anonymous function?
|
|
#[cfg(not(feature = "no_function"))]
|
|
#[inline(always)]
|
|
pub fn is_anonymous(&self) -> bool {
|
|
self.0.starts_with(crate::engine::FN_ANONYMOUS)
|
|
}
|
|
/// Call the function pointer with curried arguments (if any).
|
|
///
|
|
/// If this function is a script-defined function, it must not be marked private.
|
|
///
|
|
/// ## WARNING
|
|
///
|
|
/// 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.
|
|
#[inline(always)]
|
|
pub fn call_dynamic(
|
|
&self,
|
|
ctx: NativeCallContext,
|
|
this_ptr: Option<&mut Dynamic>,
|
|
mut arg_values: impl AsMut<[Dynamic]>,
|
|
) -> Result<Dynamic, Box<EvalAltResult>> {
|
|
let arg_values = arg_values.as_mut();
|
|
|
|
let mut args_data = self
|
|
.curry()
|
|
.iter()
|
|
.cloned()
|
|
.chain(arg_values.iter_mut().map(mem::take))
|
|
.collect::<StaticVec<_>>();
|
|
|
|
let mut args = args_data.iter_mut().collect::<StaticVec<_>>();
|
|
|
|
let is_method = this_ptr.is_some();
|
|
|
|
if let Some(obj) = this_ptr {
|
|
args.insert(0, obj);
|
|
}
|
|
|
|
ctx.call_fn_dynamic_raw(self.fn_name(), is_method, true, args.as_mut(), None)
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for FnPtr {
|
|
#[inline(always)]
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
write!(f, "Fn({})", self.0)
|
|
}
|
|
}
|
|
|
|
impl TryFrom<ImmutableString> for FnPtr {
|
|
type Error = Box<EvalAltResult>;
|
|
|
|
#[inline(always)]
|
|
fn try_from(value: ImmutableString) -> Result<Self, Self::Error> {
|
|
if is_valid_identifier(value.chars()) {
|
|
Ok(Self(value, Default::default()))
|
|
} else {
|
|
EvalAltResult::ErrorFunctionNotFound(value.into(), Position::NONE).into()
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TryFrom<String> for FnPtr {
|
|
type Error = Box<EvalAltResult>;
|
|
|
|
#[inline(always)]
|
|
fn try_from(value: String) -> Result<Self, Self::Error> {
|
|
let s: ImmutableString = value.into();
|
|
Self::try_from(s)
|
|
}
|
|
}
|
|
|
|
impl TryFrom<&str> for FnPtr {
|
|
type Error = Box<EvalAltResult>;
|
|
|
|
#[inline(always)]
|
|
fn try_from(value: &str) -> Result<Self, Self::Error> {
|
|
let s: ImmutableString = value.into();
|
|
Self::try_from(s)
|
|
}
|
|
}
|
|
|
|
/// A general function trail object.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type FnAny = dyn Fn(NativeCallContext, &mut FnCallArgs) -> Result<Dynamic, Box<EvalAltResult>>;
|
|
/// A general function trail object.
|
|
#[cfg(feature = "sync")]
|
|
pub type FnAny =
|
|
dyn Fn(NativeCallContext, &mut FnCallArgs) -> Result<Dynamic, Box<EvalAltResult>> + Send + Sync;
|
|
|
|
/// A standard function that gets an iterator from a type.
|
|
pub type IteratorFn = fn(Dynamic) -> Box<dyn Iterator<Item = Dynamic>>;
|
|
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type FnPlugin = dyn PluginFunction;
|
|
#[cfg(feature = "sync")]
|
|
pub type FnPlugin = dyn PluginFunction + Send + Sync;
|
|
|
|
/// A standard callback function for progress reporting.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type OnProgressCallback = Box<dyn Fn(u64) -> Option<Dynamic> + 'static>;
|
|
/// A standard callback function for progress reporting.
|
|
#[cfg(feature = "sync")]
|
|
pub type OnProgressCallback = Box<dyn Fn(u64) -> Option<Dynamic> + Send + Sync + 'static>;
|
|
|
|
/// A standard callback function for printing.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type OnPrintCallback = Box<dyn Fn(&str) + 'static>;
|
|
/// A standard callback function for printing.
|
|
#[cfg(feature = "sync")]
|
|
pub type OnPrintCallback = Box<dyn Fn(&str) + Send + Sync + 'static>;
|
|
|
|
/// A standard callback function for debugging.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type OnDebugCallback = Box<dyn Fn(&str, Option<&str>, Position) + 'static>;
|
|
/// A standard callback function for debugging.
|
|
#[cfg(feature = "sync")]
|
|
pub type OnDebugCallback = Box<dyn Fn(&str, Option<&str>, Position) + Send + Sync + 'static>;
|
|
|
|
/// A standard callback function for variable access.
|
|
#[cfg(not(feature = "sync"))]
|
|
pub type OnVarCallback =
|
|
Box<dyn Fn(&str, usize, &EvalContext) -> Result<Option<Dynamic>, Box<EvalAltResult>> + 'static>;
|
|
/// A standard callback function for variable access.
|
|
#[cfg(feature = "sync")]
|
|
pub type OnVarCallback = Box<
|
|
dyn Fn(&str, usize, &EvalContext) -> Result<Option<Dynamic>, Box<EvalAltResult>>
|
|
+ Send
|
|
+ Sync
|
|
+ 'static,
|
|
>;
|
|
|
|
/// A type encapsulating a function callable by Rhai.
|
|
#[derive(Clone)]
|
|
pub enum CallableFunction {
|
|
/// A pure native Rust function with all arguments passed by value.
|
|
Pure(Shared<FnAny>),
|
|
/// A native Rust object method with the first argument passed by reference,
|
|
/// and the rest passed by value.
|
|
Method(Shared<FnAny>),
|
|
/// An iterator function.
|
|
Iterator(IteratorFn),
|
|
/// A plugin function,
|
|
Plugin(Shared<FnPlugin>),
|
|
/// A script-defined function.
|
|
#[cfg(not(feature = "no_function"))]
|
|
Script(Shared<ScriptFnDef>),
|
|
}
|
|
|
|
impl fmt::Debug for CallableFunction {
|
|
#[inline(always)]
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
match self {
|
|
Self::Pure(_) => write!(f, "NativePureFunction"),
|
|
Self::Method(_) => write!(f, "NativeMethod"),
|
|
Self::Iterator(_) => write!(f, "NativeIterator"),
|
|
Self::Plugin(_) => write!(f, "PluginFunction"),
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(fn_def) => fmt::Debug::fmt(fn_def, f),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl fmt::Display for CallableFunction {
|
|
#[inline(always)]
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
match self {
|
|
Self::Pure(_) => write!(f, "NativePureFunction"),
|
|
Self::Method(_) => write!(f, "NativeMethod"),
|
|
Self::Iterator(_) => write!(f, "NativeIterator"),
|
|
Self::Plugin(_) => write!(f, "PluginFunction"),
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
CallableFunction::Script(s) => fmt::Display::fmt(s, f),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl CallableFunction {
|
|
/// Is this a pure native Rust function?
|
|
#[inline(always)]
|
|
pub fn is_pure(&self) -> bool {
|
|
match self {
|
|
Self::Pure(_) => true,
|
|
Self::Method(_) | Self::Iterator(_) => false,
|
|
|
|
Self::Plugin(p) => !p.is_method_call(),
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => false,
|
|
}
|
|
}
|
|
/// Is this a native Rust method function?
|
|
#[inline(always)]
|
|
pub fn is_method(&self) -> bool {
|
|
match self {
|
|
Self::Method(_) => true,
|
|
Self::Pure(_) | Self::Iterator(_) => false,
|
|
|
|
Self::Plugin(p) => p.is_method_call(),
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => false,
|
|
}
|
|
}
|
|
/// Is this an iterator function?
|
|
#[inline(always)]
|
|
pub fn is_iter(&self) -> bool {
|
|
match self {
|
|
Self::Iterator(_) => true,
|
|
Self::Pure(_) | Self::Method(_) | Self::Plugin(_) => false,
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => false,
|
|
}
|
|
}
|
|
/// Is this a Rhai-scripted function?
|
|
#[inline(always)]
|
|
pub fn is_script(&self) -> bool {
|
|
match self {
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => true,
|
|
|
|
Self::Pure(_) | Self::Method(_) | Self::Iterator(_) | Self::Plugin(_) => false,
|
|
}
|
|
}
|
|
/// Is this a plugin function?
|
|
#[inline(always)]
|
|
pub fn is_plugin_fn(&self) -> bool {
|
|
match self {
|
|
Self::Plugin(_) => true,
|
|
Self::Pure(_) | Self::Method(_) | Self::Iterator(_) => false,
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => false,
|
|
}
|
|
}
|
|
/// Is this a native Rust function?
|
|
#[inline(always)]
|
|
pub fn is_native(&self) -> bool {
|
|
match self {
|
|
Self::Pure(_) | Self::Method(_) => true,
|
|
Self::Plugin(_) => true,
|
|
Self::Iterator(_) => true,
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => false,
|
|
}
|
|
}
|
|
/// Get the access mode.
|
|
#[inline(always)]
|
|
pub fn access(&self) -> FnAccess {
|
|
match self {
|
|
Self::Plugin(_) => FnAccess::Public,
|
|
Self::Pure(_) | Self::Method(_) | Self::Iterator(_) => FnAccess::Public,
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(f) => f.access,
|
|
}
|
|
}
|
|
/// Get a shared reference to a native Rust function.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if the [`CallableFunction`] is not [`Pure`][CallableFunction::Pure] or
|
|
/// [`Method`][CallableFunction::Method].
|
|
#[inline(always)]
|
|
pub fn get_native_fn(&self) -> &FnAny {
|
|
match self {
|
|
Self::Pure(f) | Self::Method(f) => f.as_ref(),
|
|
Self::Iterator(_) | Self::Plugin(_) => panic!("function should be native"),
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => panic!("function should be native"),
|
|
}
|
|
}
|
|
/// Get a shared reference to a script-defined function definition.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if the [`CallableFunction`] is not [`Script`][CallableFunction::Script].
|
|
#[cfg(not(feature = "no_function"))]
|
|
#[inline(always)]
|
|
pub fn get_fn_def(&self) -> &ScriptFnDef {
|
|
match self {
|
|
Self::Pure(_) | Self::Method(_) | Self::Iterator(_) | Self::Plugin(_) => {
|
|
panic!("function should be scripted")
|
|
}
|
|
Self::Script(f) => f.as_ref(),
|
|
}
|
|
}
|
|
/// Get a reference to an iterator function.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if the [`CallableFunction`] is not [`Iterator`][CallableFunction::Iterator].
|
|
#[inline(always)]
|
|
pub fn get_iter_fn(&self) -> IteratorFn {
|
|
match self {
|
|
Self::Iterator(f) => *f,
|
|
Self::Pure(_) | Self::Method(_) | Self::Plugin(_) => {
|
|
panic!("function should an iterator")
|
|
}
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => panic!("function should be an iterator"),
|
|
}
|
|
}
|
|
/// Get a shared reference to a plugin function.
|
|
///
|
|
/// # Panics
|
|
///
|
|
/// Panics if the [`CallableFunction`] is not [`Plugin`][CallableFunction::Plugin].
|
|
#[inline(always)]
|
|
pub fn get_plugin_fn<'s>(&'s self) -> &FnPlugin {
|
|
match self {
|
|
Self::Plugin(f) => f.as_ref(),
|
|
Self::Pure(_) | Self::Method(_) | Self::Iterator(_) => {
|
|
panic!("function should a plugin")
|
|
}
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_) => panic!("function should a plugin"),
|
|
}
|
|
}
|
|
/// Create a new [`CallableFunction::Pure`].
|
|
#[inline(always)]
|
|
pub fn from_pure(func: Box<FnAny>) -> Self {
|
|
Self::Pure(func.into())
|
|
}
|
|
/// Create a new [`CallableFunction::Method`].
|
|
#[inline(always)]
|
|
pub fn from_method(func: Box<FnAny>) -> Self {
|
|
Self::Method(func.into())
|
|
}
|
|
/// Create a new [`CallableFunction::Plugin`].
|
|
#[inline(always)]
|
|
pub fn from_plugin(func: impl PluginFunction + 'static + SendSync) -> Self {
|
|
Self::Plugin((Box::new(func) as Box<FnPlugin>).into())
|
|
}
|
|
}
|
|
|
|
impl From<IteratorFn> for CallableFunction {
|
|
#[inline(always)]
|
|
fn from(func: IteratorFn) -> Self {
|
|
Self::Iterator(func)
|
|
}
|
|
}
|
|
|
|
impl From<ScriptFnDef> for CallableFunction {
|
|
#[inline(always)]
|
|
fn from(_func: ScriptFnDef) -> Self {
|
|
#[cfg(feature = "no_function")]
|
|
unreachable!("no_function active");
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_func.into())
|
|
}
|
|
}
|
|
|
|
impl From<Shared<ScriptFnDef>> for CallableFunction {
|
|
#[inline(always)]
|
|
fn from(_func: Shared<ScriptFnDef>) -> Self {
|
|
#[cfg(feature = "no_function")]
|
|
unreachable!("no_function active");
|
|
|
|
#[cfg(not(feature = "no_function"))]
|
|
Self::Script(_func)
|
|
}
|
|
}
|
|
|
|
impl<T: PluginFunction + 'static + SendSync> From<T> for CallableFunction {
|
|
#[inline(always)]
|
|
fn from(func: T) -> Self {
|
|
Self::from_plugin(func)
|
|
}
|
|
}
|
|
|
|
impl From<Shared<FnPlugin>> for CallableFunction {
|
|
#[inline(always)]
|
|
fn from(func: Shared<FnPlugin>) -> Self {
|
|
Self::Plugin(func.into())
|
|
}
|
|
}
|