Struct Workflow 

pub struct Workflow { /* private fields */ }

In-memory workflow with journaled versioning for AIMX rules.

Maintains ordered rule rows plus identifier lookup, tracks changes as Changes, and persists via versioned AIM/journal files.

Implementations

impl Workflow

pub fn for_testing(locator: Arc<Reference>) -> Result<Self>

Creates a new empty workflow.

The workflow starts with:

• Empty rule storage
• Version 0.0
• Extract inference pattern
• Empty path and reference
• No changes pending
• Change tracking disabled

pub fn parse_for_tests(input: &str) -> Result<Self>

Creates a new workflow by parsing AIM content.

This constructor parses the provided AIM content and creates a workflow with the parsed rules. Change tracking is automatically enabled.

pub fn new_from(locator: Arc<Reference>, path: Arc<PathBuf>) -> Self

pub fn open(locator: Arc<Reference>) -> Result<Self>

Creates a new workflow by loading from a global locator (Reference).

This constructor loads a workflow from the file system based on the provided locator. If the file doesn’t exist, an empty workflow is created with the locator set.

pub fn is_touched(&self) -> bool

Checks if the workflow has unsaved changes.

Returns

true if the workflow has changes that need to be saved, false otherwise.

pub fn set_partial_change(&mut self)

Flags changes that only require a partial save.

This method escalates the change status from None to Partial. If changes are already at Partial or Version, they remain unchanged.

pub fn set_version_change(&mut self)

Flags changes that require a version change on save.

This method sets the change status to Version, indicating that structural changes have been made that require a new version.

pub fn clear_changes(&mut self)

Clears the changes flag.

This method is typically called after a successful save operation to reset the change tracking state.

pub fn first_version(&self) -> u32

Gets the first version number from the journal.

Returns

The epoch of the first version, or 0 if no versions exist.

pub fn latest_version(&self) -> u32

Gets the latest version number from the journal.

Returns

The epoch of the latest version, or 0 if no versions exist.

pub fn set_path(&mut self, path: &Path)

Test-only: override the workflow file path.

pub fn load_version(&mut self, version: u32, partial: Option<u32>) -> Result<()>

Loads a specific version of an AIM file.

This method loads a particular version (and optionally a specific partial) from the AIM file. After loading, the workflow switches back to the latest version but flags that a version change is needed since the loaded version differs from the current one.

Parameters

• path - The path to the AIM file
• version - The epoch version to load
• partial - Optional partial version within the epoch

Returns

Ok(()) if successful, or an error if the version cannot be loaded.

pub fn load(&mut self) -> Result<()>

Loads the latest version of an AIM file.

This method loads the most recent version from the AIM file and clears any pending changes. Change tracking is enabled after loading.

Parameters

• path - The path to the AIM file

Returns

Ok(()) if successful, or an error if the file cannot be loaded.

pub fn save(&mut self) -> Result<()>

Saves the AIM structure to its associated file.

This function saves changes to the AIM file based on the type of changes made:

• Changes::Version: Creates a new version with incremented epoch
• Changes::Partial: Creates a partial update with incremented partial counter
• Changes::None: No changes to save, returns Ok(())

The function also updates the journal file with position information for fast lookup.

Returns

Ok(()) if successful, or an error if the save operation fails.

pub fn save_all(&mut self) -> Result<()>

pub fn check_identifier_unique(&self, identifier: &str) -> Result<()>

pub fn add_node( &mut self, identifier: Arc<str>, node: Node, ) -> Result<Arc<Reference>>

pub fn copy_node(&mut self, from: &Node, to: Arc<str>) -> Result<()>

pub fn get_node(&self, identifier: &str) -> Result<Node>

pub fn rename_node(&mut self, from: &str, to: Arc<str>) -> Result<()>

pub fn delete_node(&mut self, identifier: &str) -> Result<()>

pub fn add_instance( &mut self, identifier: Arc<str>, source: Arc<Reference>, target: Arc<Reference>, ) -> Result<()>

pub fn append_or_update(&mut self, row: Row)

Appends a row to the workflow or updates an existing rule.

If a rule with the same identifier already exists, it is updated. Otherwise, the rule is appended to the end of the workflow.

Parameters

• row - The rule to append or update

pub fn update_rule(&mut self, rule: Arc<Rule>) -> Result<()>

Updates an existing rule.

Parameters

• rule - The updated rule

Returns

Ok(()) if successful, or an error if the rule doesn’t exist.

pub fn update_value( &mut self, identifier: &str, value: Arc<Value>, ) -> Result<()>

Updates an existing rule value.

Parameters

• identifier = The rule identifier
• value - The new value

Returns

Ok(()) if successful, or an error if the rule doesn’t exist.

pub fn delete_rule(&mut self, identifier: &str) -> Row

Deletes a rule by identifier.

Parameters

• identifier - The rule identifier to delete

Returns

Some(Rule) if the rule was deleted, None if it didn’t exist.

pub fn set_row(&mut self, index: usize, row: Row) -> Result<()>

Sets a rule at a specific row index.

If a rule already exists at the specified index with a different identifier, this method will return an error. If the index is beyond the current size of the workflow, the rows vector will be expanded to accommodate it.

Parameters

• index - The zero-based row index where to place the rule
• row - The rule to set, or None to create an empty row

Returns

Ok(()) if successful, or an error if there’s a conflict with an existing rule

pub fn insert_row(&mut self, index: usize, row: Row) -> Result<()>

Inserts a rule at a specific row index.

This method inserts a rule at the specified index, shifting existing rules to higher indices. If the index is beyond the current size of the workflow, empty rows will be created as needed. If a rule with the same identifier already exists in the workflow, this method returns an error.

Parameters

• index - The zero-based row index where to insert the rule
• row - The rule to insert, or None to create an empty row

Returns

Ok(()) if successful, or an error if a rule with the same identifier already exists

pub fn reposition_row(&mut self, from: usize, to: usize) -> Result<()>

Repositions a rule from one row index to another.

This method moves a rule from the from index to the to index, shifting other rules as needed. If either index is beyond the current size of the workflow, the rows vector will be expanded to accommodate them.

Parameters

• from - The current zero-based row index of the rule to move
• to - The target zero-based row index where to place the rule

Returns

Ok(()) if successful, or an error if the operation fails

pub fn replace_row(&mut self, index: usize, row: Row) -> Result<()>

pub fn clear_row(&mut self, index: usize) -> Row

Clears a row at a specific index, removing the rule if present.

This method removes the rule at the specified index but keeps the row structure intact. The row will become empty but still exist in the workflow. If the index is out of bounds, this method returns None.

Parameters

• index - The zero-based row index to clear

Returns

Some(Rule) if a rule was present and removed, None if the row was already empty or index was out of bounds

pub fn remove_row(&mut self, index: usize) -> Row

Removes a row at a specific index, removing the rule and shrinking the workflow.

This method removes the rule at the specified index and removes the row entirely from the workflow, shifting subsequent rows to lower indices. If the index is out of bounds, this method returns None.

Parameters

• index - The zero-based row index to remove

Returns

Some(Rule) if a rule was present and removed, None if the index was out of bounds

pub fn iter_with_rows(&self) -> impl Iterator<Item = (usize, &Row)>

Create an iterator over the rules with their indices.

This iterator yields tuples of (index, &Option<Rule>), providing both the position and content of each row including empty ones.

pub fn reindex(&mut self)

Rebuilds the lookup mapping index.

This helper function rebuilds the internal hash map that maps rule identifiers to their row indices. It’s called automatically after operations that change the position of rules within the workflow.

pub fn parse(&mut self, input: &str, partial: Option<u32>) -> Result<()>

Parses AIM content and populates the workflow.

This method parses AIM format content and creates rules based on the parsed data. It can optionally parse only up to a specific partial version. The method clears the current workflow contents before parsing.

Special tokens and their meanings

• [ .. ] HEADER: Used to signify a version header.
• : PARTIAL: Used inside a workflow header to signify a minor version number.
• @ DATETIME: Used inside a workflow header to signify the snapshot date and time.
• # COMMENT: Used to signify a comment.
• $ CONSTANT: Used inside rule a definitions to signify a constant variable.
• ( .. ) Delimits expression parenthesis
• { .. } Delimits and expression collection
• " | ' Delimits strings
• ^, !, &, %, * Potentially available

Parameters

• input - The AIM content to parse
• partial - Optional partial version to parse up to

Returns

Ok(()) if parsing was successful, or an error if parsing failed

pub fn print(&self, writer: &mut Writer)

pub fn to_formula(&self) -> String

Return the formula-string representation (round-trippable by the parser).

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workflow

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

Formats the value using the given formatter.

impl Display for Workflow

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

Formats the value using the given formatter.

impl PartialEq<Reference> for Workflow

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Workflow> for Reference

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Workflow

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WorkflowLike for Workflow

fn locator(&self) -> Arc<Reference>

Returns the global locator (Reference) for this workflow.

fn path(&self) -> Arc<PathBuf>

Returns the file system path to the workflow’s AIM file.

fn date(&self) -> DateTime

fn version(&self) -> u32

Returns the major version (epoch) of the workflow.

fn minor_version(&self) -> u32

Returns the minor version (partial) of the workflow.

fn get_index(&self, identifier: &str) -> Option<usize>

Gets the row index of a rule by identifier.

fn has_rule(&self, index: usize) -> bool

Checks if a specific row index contains a rule.

fn get_row(&self, index: usize) -> Row

Retrieves a rule by its row index.

fn contains(&self, identifier: &str) -> bool

Checks if a rule with the given identifier exists.

fn get_rule(&self, identifier: &str) -> Option<Arc<Rule>>

Retrieves a rule by its identifier.

fn rule_count(&self) -> usize

Returns the number of rules in the workflow.

fn row_count(&self) -> usize

Returns the total number of rows in the workflow.

fn iter_rows<'a>(&'a self) -> Box<dyn Iterator<Item = &'a Row> + 'a>

Returns an iterator over all rows.

fn iter_rules(&self) -> Box<dyn Iterator<Item = Arc<Rule>> + '_>

Returns an iterator over all rules.

fn as_any(&self) -> &dyn Any

Returns a reference to the workflow as a trait object.

impl WriterLike for Workflow

fn write(&self, writer: &mut Writer)

Serialize this expression with the given Writer.

fn to_stringized(&self) -> String

Return a string representation (raw unsafe output).

fn to_sanitized(&self) -> String

Return a sanitized string representation (escaped for safe output).

fn to_expressionized(&self) -> String

Return a sanitized string representation (escaped for safe output).