Struct origen::TEST

pub struct TEST { /* fields omitted */ }

Storage for the current test (pattern)

Methods from Deref<Target = TestManager>

pub fn start(&self, name: &str)

Starts a new test (deletes the current AST and starts a new one)

pub fn push(&self, node: Node)

Push a new terminal node into the AST

pub fn append(&self, nodes: &mut Vec<Node>)

pub fn push_and_open(&self, node: Node) -> usize

Push a new node into the AST and leave it open, meaning that all new nodes added to the AST will be inserted as children of this node until it is closed. A reference ID is returned and the caller should save this and provide it again when calling close(). If the reference does not match the expected an error will be raised. This will catch any cases of application code forgetting to close a node before closing one of its parents.

pub fn close(&self, ref_id: usize) -> Result<()>

Close the currently open node

pub fn replace(&self, node: Node, offset: usize) -> Result<()>

Replace the node n - offset with the given node, use offset = 0 to replace the last node that was pushed. Fails if the AST has no children yet or if the offset is otherwise out of range.

pub fn get(&self, offset: usize) -> Result<Node>

Returns a copy of node n - offset, an offset of 0 means the last node pushed. Fails if the offset is out of range.

pub fn get_with_descendants(&self, offset: usize) -> Result<Node>

Returns a copy of node n - offset, where an offset of 0 means the last node pushed. Differs from ‘get’ in that the offset will step into all nodes’ children. For example, in the AST: n1 n2 n2.1 n2.2 n3 offset | get(offset) | get_with_descendants(offset) 0 | n3 | n3 1 | n2 | n2.2 2 | n1 | n2.1

Fails if the offset is out of range.

pub fn insert(&self, node: Node, offset: usize) -> Result<()>

Insert the node at position n - offset, using offset = 0 is equivalent calling push().

pub fn to_string(&self) -> String

pub fn process(
    &self,
    process_fn: &mut dyn FnMut(&Node) -> Result<Node>
) -> Result<Node>

pub fn with_ast<T, F>(&self, process_fn: F) -> Result<T> where
    F: FnMut(&Node) -> Result<T>, 

Execute the given function which receives the a reference to the AST (as a Node) as an input, returning the result of the function

pub fn to_node(&self) -> Node

pub fn to_pickle(&self) -> Vec<u8>

Serializes the AST for import into Python

Trait Implementations

impl Debug for TEST

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

Formats the value using the given formatter.

impl Deref for TEST

type Target = TestManager

The resulting type after dereferencing.

fn deref(&self) -> &TestManager

Dereferences the value.

impl LazyStatic for TEST

fn initialize(lazy: &Self)

impl PartialEq<AST> for TEST

fn eq(&self, ast: &AST) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Node> for TEST

fn eq(&self, node: &Node) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<TEST> for AST

fn eq(&self, test: &TEST) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.