class

Sthx::Capture

Inherits Sthx::Rule < Reference < Object

Wraps the result of running a rule, in a tree with the given id. "The result" here stands for trees produced by subordinate captures, or attributes assigned directly within the capture (not within subordinate captures!)

Constructors

new(rule : Rule, id : String)

Source

Instance methods

advance(cursor : Cursor, data : TreeData, *, collect : Collect) : Advance::Result

Performs cursor motion and returns the result, one of Advance::Result: success Advance::Ok or failure Advance::Err.

data is the TreeData object built so far.

To implementors of this method: in case of failure to commit, cursor must be rolled back to its state before calling this method. In other words, advance is implemented in a "transaction" kind of way. Intermediate results and changes must never be available to the caller. This method either succeeds and mutates the cursor; or it fails and leaves the cursor intact.

Source