Struct Parser

pub struct Parser<const OSC_RAW_BUF_SIZE: usize = MAX_OSC_RAW> { /* private fields */ }

Parser for raw VTE protocol which delegates actions to a Perform

Generic over the value for the size of the raw Operating System Command buffer. Only used when the std feature is not enabled.

Implementations

impl Parser

pub fn new() -> Parser

Create a new Parser

Examples found in repository

examples/parselog.rs (line 56)

fn main() {
    let input = io::stdin();
    let mut handle = input.lock();

    let mut statemachine = Parser::new();
    let mut performer = Log;

    let mut buf = [0; 2048];

    loop {
        match handle.read(&mut buf) {
            Ok(0) => break,
            Ok(n) => statemachine.advance(&mut performer, &buf[..n]),
            Err(err) => {
                println!("err: {}", err);
                break;
            },
        }
    }
}

impl<const OSC_RAW_BUF_SIZE: usize> Parser<OSC_RAW_BUF_SIZE>

pub fn advance<P: Perform>(&mut self, performer: &mut P, bytes: &[u8])

Advance the parser state.

Requires a Perform implementation to handle the triggered actions.

Examples found in repository

examples/parselog.rs (line 64)

fn main() {
    let input = io::stdin();
    let mut handle = input.lock();

    let mut statemachine = Parser::new();
    let mut performer = Log;

    let mut buf = [0; 2048];

    loop {
        match handle.read(&mut buf) {
            Ok(0) => break,
            Ok(n) => statemachine.advance(&mut performer, &buf[..n]),
            Err(err) => {
                println!("err: {}", err);
                break;
            },
        }
    }
}

pub fn advance_until_terminated<P: Perform>( &mut self, performer: &mut P, bytes: &[u8], ) -> usize

Partially advance the parser state.

This is equivalent to Self::advance, but stops when Perform::terminated is true after reading a byte.

Returns the number of bytes read before termination.

See [Perform::advance] for more details.

Trait Implementations

impl<const OSC_RAW_BUF_SIZE: usize> Default for Parser<OSC_RAW_BUF_SIZE>

fn default() -> Parser<OSC_RAW_BUF_SIZE>

Returns the “default value” for a type.