Struct vte::Parser

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

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 no_std feature is enabled.

Implementations§

source§

impl Parser

source

pub fn new() -> Parser

Create a new Parser

Examples found in repository?
examples/parselog.rs (line 56)
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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) => {
                for byte in &buf[..n] {
                    statemachine.advance(&mut performer, *byte);
                }
            },
            Err(err) => {
                println!("err: {}", err);
                break;
            },
        }
    }
}
source§

impl<const OSC_RAW_BUF_SIZE: usize> Parser<OSC_RAW_BUF_SIZE>

source

pub fn new_with_size() -> Parser<OSC_RAW_BUF_SIZE>

Create a new Parser with a custom size for the Operating System Command buffer.

Call with a const-generic param on Parser, like:

let mut p = vte::Parser::<64>::new_with_size();
source

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

Advance the parser state

Requires a Perform in case byte triggers an action

Examples found in repository?
examples/parselog.rs (line 66)
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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) => {
                for byte in &buf[..n] {
                    statemachine.advance(&mut performer, *byte);
                }
            },
            Err(err) => {
                println!("err: {}", err);
                break;
            },
        }
    }
}

Trait Implementations§

source§

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

source§

fn default() -> Parser<OSC_RAW_BUF_SIZE>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.