Enum Token

pub enum Token {
    Leaf {
        token_type: TokenType,
        token_str: String,
    },
    Branch {
        token_type: TokenType,
        children: Vec<Token>,
    },
}

Used for tokenizing Suiron source.

Variants

Leaf

• Valid token_types are:
  Subgoal, Comma, Semicolon, LParen, RParen
  
• token_str holds the item being parsed,
  such as (, ;, or a_subgoal(term1, term2).

Fields

token_type: TokenType

token_str: String

Branch

This is a parent node.

• Valid token_types are: Group, And, Or
  
• children is a vector of child tokens

Fields

token_type: TokenType

children: Vec<Token>

Implementations

impl Token

pub fn number_of_children(&self) -> usize

Gets the number of children of a branch (parent) token.

Arguments

• self

Return

• number of children

Panics

• If the token is not a branch token.

Usage

use suiron::*;

let l1 = make_leaf_token("subgoal1()");
let l2 = make_leaf_token("subgoal2()");
let branch = make_branch_token(TokenType::And, vec![l1, l2]);
let n = branch.number_of_children();  // n = 2

pub fn get_type(&self) -> TokenType

Gets the token type.

Arguments

• self

Return

• TokenType

Usage

use suiron::*;

let tok = make_leaf_token("all(destiny)");
let type1 = tok.get_type(); // type1 = Subgoal

pub fn get_token_str(&self) -> String

Gets the token string. Valid only for leaf tokens.

Arguments

• self

Return

• token string

Panics

• If the token is not a leaf token.

Usage

use suiron::*;

let tok = make_leaf_token("all(destiny)");
let s = tok.get_token_str();  // s = "all(destiny)"

pub fn get_children(&self) -> Vec<Token>

Gets the child tokens of a parent (branch) token.

Arguments

• self

Return

• vector of tokens

Panics

• If the token is not a branch token.

Usage

use suiron::*;

let t1 = make_leaf_token("left");
let t2 = make_leaf_token("right");
let t3 = make_branch_token(TokenType::Or, vec![t1, t2]);
let children = t3.get_children();
println!("{:?}", children);

The above prints:
[Leaf { token_type: Subgoal, token_str: "left" }, Leaf { token_type: Subgoal, token_str: "right" }]

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Display for Token

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

Formats the value using the given formatter.

impl PartialEq for Token

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

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

const 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 StructuralPartialEq for Token