Struct ScriptMeta 

pub struct ScriptMeta {
    pub command: Option<String>,
    pub hint: Option<String>,
    pub args: Option<Value>,
    pub node: Option<(Vec<Port>, Vec<Port>)>,
    pub problems: Vec<(usize, String)>,
}

What a script’s header says it is.

Fields

command: Option<String>

As a command: its title.

hint: Option<String>

What it does.

args: Option<Value>

The JSON Schema of its arguments (as a command).

node: Option<(Vec<Port>, Vec<Port>)>

As a pipeline node: its inputs and outputs.

problems: Vec<(usize, String)>

What in the header did not read (line, why).

Implementations

impl ScriptMeta

pub fn parse(text: &str) -> ScriptMeta

Reads the kitchen: lines at the top of text (# or // comments, up to the first line that is neither a comment nor blank).

Trait Implementations

impl Clone for ScriptMeta

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptMeta

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

Formats the value using the given formatter.

impl Default for ScriptMeta

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ScriptMeta

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ScriptMeta