Struct Macro 

pub struct Macro {
    pub v: u32,
    pub name: String,
    pub description: String,
    pub shortcut: Option<String>,
    pub inputs: Vec<NamedInput>,
    pub steps: Vec<Step>,
    pub output: OutputRule,
    pub permissions: Vec<String>,
}

A recorded or hand-made macro: a list of typed steps that runs as one undo step. Most steps run a GridCraft command; Repeat, If and Stop add bounded control flow. References in step parameters can be tokens ("Input.col(2)") that are resolved against the declared inputs when the macro runs, so a macro recorded on one block of data works on another.

Fields

v: u32

Format version (MACRO_VERSION).

name: String

description: String

shortcut: Option<String>

Keyboard shortcut (Ctrl+Shift+M) for a user interface to offer; the engine only stores it.

inputs: Vec<NamedInput>

The ranges the macro works on, checked before it runs.

steps: Vec<Step>

output: OutputRule

Where results go and what to do when they would land on existing data.

permissions: Vec<String>

Commands that need permission (reading or writing files) which the macro may run.

Implementations

impl Macro

pub fn step_count(&self) -> usize

Steps in the macro, counting those inside Repeat and If.

pub fn check_limits(&self) -> Result<(), String>

Checks every field a file can set: the format version (check_version); the lengths of the name, description, shortcut, notes, messages, references and command ids; the counts of steps (MAX_MACRO_STEPS), inputs, permissions and column types; the nesting depth (MAX_MACRO_DEPTH); and each input’s declaration. Command parameters are bounded only by the size of the whole macro, which MAX_MACRO_STEPS and the workbook’s item limit cap. Every struct is taken apart field by field, so a field added later doesn’t compile here until someone decides its limit.

Trait Implementations

impl Clone for Macro

fn clone(&self) -> Macro

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Macro

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

Formats the value using the given formatter.

impl Default for Macro

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Macro

where Macro: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<Macro> for Macros

fn from_iter<I: IntoIterator<Item = Macro>>(iter: I) -> Macros

Creates a value from an iterator.

impl PartialEq for Macro

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Macro

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Macro