Enum forne::RawMethod

pub enum RawMethod {
    Inbuilt(String),
    Custom {
        name: String,
        body: String,
    },
}

A representation of a method that has not yet been created.

Variants

Inbuilt(String)

An inbuilt method, with the name attached.

Custom

Fields

name: String

The name of the script. The provided method name must not overlap with that of any other custom method, and it is strongly recommended that users prefix their own name or handle in front of the names of scripts they write to avoid users of these scripts accidentally causing conflicts with scripts written by others.

E.g. if Alice writes a custom method script and distributes it on the internet with the name powerlearn-v2, and Bob starts using it, but then later decides to use a different script made by Chloe, also called powerlearn-v2, Forne will unwittingly pass the metadata Alice’s script expected to Chloe’s, at best causing it to completely fail, and at worst causing all Bob’s previous data to be overwritten irretrievably. This could be avoided if Alice produced alice/powerlearn-v2 and Chloe produces chloe/powerlearn-v2.

body: String

The body of the Rhai script that defines this method, which must contain several key elements (see the documentation of custom methods to learn more about these).

A custom method defined by a Rhai script.

Implementations

impl RawMethod

pub fn is_inbuilt(method: &str) -> bool

Determines whether or not the given method name or script is inbuilt. This can be used in situations of ambiguity, such as in a CLI, where a path to a custom script or the name of an inbuilt method may be provided with no immediate distinction.

Trait Implementations

impl Clone for RawMethod

fn clone(&self) -> RawMethod

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawMethod

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

Formats the value using the given formatter.