Trait Bound 

pub trait Bound:
    Copy
    + Send
    + Sync
    + 'static {
    const NAME: &'static str;
    const DOC: &'static str;
    const PARTS: &'static [&'static [Function<Self>]];

    // Required method
    fn resolve(load: &mut Load<'_>) -> Result<Self, Off>;

    // Provided method
    fn functions() -> impl Iterator<Item = &'static Function<Self>> { ... }
}

Available on crate feature unstable only.

A part of the API a script reaches as one namespace, such as world.

Examples

See Function.

Required Associated Constants

const NAME: &'static str

The namespace’s name in a script.

const DOC: &'static str

What the namespace is for, one sentence.

const PARTS: &'static [&'static [Function<Self>]]

The method lists of every #[script] block of the type.

Required Methods

fn resolve(load: &mut Load<'_>) -> Result<Self, Off>

The value a script’s calls go to, for the mod load initialises.

Errors

Off when the game build lacks what the part needs; the script runs without that namespace.

Provided Methods

fn functions() -> impl Iterator<Item = &'static Function<Self>>

Every method a script may call.

Examples

use enshwick::script::Bound;

assert!(enshwick::world::World::functions().any(|f| f.name() == "broadcast"));

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Bound for Inventories

const NAME: &'static str = "inventory"

const DOC: &'static str = "Inventories on the server: their slots and counts, and items given, taken and moved."

const PARTS: &'static [&'static [Function<Self>]]

impl Bound for Log

const NAME: &'static str = "log"

const DOC: &'static str = "The mod's log file, one line per call."

const PARTS: &'static [&'static [Function<Self>]]

impl Bound for Scheduler

const NAME: &'static str = "scheduler"

const DOC: &'static str = "Work for the server's game thread: on the next pass, after a delay, or repeatedly."

const PARTS: &'static [&'static [Function<Self>]]

impl Bound for World

const NAME: &'static str = "world"

const DOC: &'static str = "The server's world: players, chat, notices and positions. Unstable: may change in any release."

const PARTS: &'static [&'static [Function<Self>]]