Struct parol::generators::scanner_config::ScannerConfig

pub struct ScannerConfig {
    pub scanner_name: String,
    pub scanner_state: usize,
    pub line_comments: Vec<String>,
    pub block_comments: Vec<(String, String)>,
    pub auto_newline: bool,
    pub auto_ws: bool,
}

Configuration information for a scanner. Contains features like to optionally switch automatic handling off and newlines off.

Fields

scanner_name: String

The name of the scanner state taken from the grammar description

scanner_state: usize

Index of the scanner, aka scanner state

line_comments: Vec<String>

Strings with the characters that starts line comments

block_comments: Vec<(String, String)>

(String, String) tuples with the characters that start and end a block comments, respectively.

auto_newline: bool

If true the lexer handles (and skips) newlines. If false the user has to handle newlines on its own.

auto_ws: bool

If true the lexer handles (and skips) whitespace. If false the user has to handle whitespace on its own.

Implementations

impl ScannerConfig

pub fn new(scanner_name: String, scanner_state: usize) -> Self

Creates a new item

pub fn with_line_comments(self, line_comments: Vec<String>) -> Self

Adds line comments to self

pub fn with_block_comments(self, block_comments: Vec<(String, String)>) -> Self

Adds block comments to self

pub fn with_auto_newline(self, auto_newline: bool) -> Self

Sets auto newline behavior

pub fn with_auto_ws(self, auto_ws: bool) -> Self

Sets auto whitespace behavior

pub fn generate_build_information( &self, cfg: &Cfg ) -> (Vec<String>, Vec<TerminalIndex>, String)

Generates the data needed by the lexer generator. The tuple contains of the specific internal tokens of the scanner (ws, comments etc.) and the indices of the terminals that are valid in this scanner.

Trait Implementations

impl Clone for ScannerConfig

fn clone(&self) -> ScannerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScannerConfig

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

Formats the value using the given formatter.

impl Default for ScannerConfig

fn default() -> Self

Returns the “default value” for a type.

impl Display for ScannerConfig

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

Formats the value using the given formatter.

impl Ord for ScannerConfig

fn cmp(&self, other: &ScannerConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ScannerConfig

fn eq(&self, other: &ScannerConfig) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ScannerConfig

fn partial_cmp(&self, other: &ScannerConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ScannerConfig

impl StructuralPartialEq for ScannerConfig