DynamicScript

Struct DynamicScript 

Source
#[repr(C)]
pub struct DynamicScript { pub script_info: extern "C" fn() -> FFiData, pub script: extern "C" fn(FFiStr, FFiData) -> FFiData, }
Expand description

A ScriptType::DynamicLib script needs to export a static instance of this struct named DynamicScript::NAME

// In a script file
#[no_mangle]
pub static SCRIPT: DynamicScript = DynamicScript { script_info: .., script: .. };

DynamicScript contains also methods for writing scripts: DynamicScript::read, DynamicScript::write

Fields§

§script_info: extern "C" fn() -> FFiData

A function that returns ScriptInfo serialized as FFiData
fn() -> ScriptInfo

§script: extern "C" fn(FFiStr, FFiData) -> FFiData

A function that accepts a hook name (casted to FFiStr) and the hook itself (serialized as FFiData) and returns the hook output (serialized as FFiData)
fn<H: Hook>(hook: &str (H::Name), data: H) -> ::Output>

Implementations§

Source§

impl DynamicScript

Source

pub const NAME: &'static [u8] = b"SCRIPT"

pub const NAME: &'static [u8] = b"SCRIPT";
Source

pub fn read<H: Hook>(hook: FFiData) -> H

Read a hook from an FFiData

Source

pub fn write<H: Hook>(output: &<H as Hook>::Output) -> FFiData

Write a value to an FFiData It takes the hook as a type argument in-order to make sure that the output provided correspond to the hook’s expected output

Auto Trait Implementations§

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> 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, 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.