A streaming push parser for the VT/xterm protocol.

Use VTPushParser::feed_with to feed bytes into the parser, handling the VTEvents as they are emitted.

use vt_push_parser::VTPushParser;
use vt_push_parser::event::VTEvent;

let mut parser = VTPushParser::new();
let mut output = String::new();
parser.feed_with(b"\x1b[32mHello, world!\x1b[0m", &mut |event: VTEvent| {
    output.push_str(&format!("{:?}", event));
});
assert_eq!(output, "Csi('32', '', 'm')Raw('Hello, world!')Csi('0', '', 'm')");

Interest

The parser can be configured to only emit certain types of events by setting the INTEREST parameter. Other event types will be parsed and discarded.

For example, to only emit CSI (and Raw) events:

use vt_push_parser::{VTPushParser, VT_PARSER_INTEREST_CSI};

let mut parser = VTPushParser::new_with_interest::<VT_PARSER_INTEREST_CSI>();

Input parsing

This crate is designed to be used for parsing terminal output, but it can also be used for parsing input. Input is not always well-formed, however and may contain mode-switching escapes that require the parser to turn off its normal parsing behaviours (ie: bracketed-paste mode, xterm mouse events, etc).

The capture::VTCapturePushParser is useful for parsing input that may work in this way.

vt-push-parser

A streaming push parser for the VT protocol.

This crate provides a push parser that can be fed bytes and will emit events as they are parsed. You can easily use this as part of a push or pull pipeline.

Zero-alloc

This crate will eventually be zero-alloc, but currently it is not zero-alloc in all cases.

Example

use vt_push_parser::{VTPushParser, event::VTEvent};

let mut parser = VTPushParser::new();

// Parse ANSI colored text
parser.feed_with(b"\x1b[32mHello\x1b[0m, world!", |event: VTEvent| {
    match event {
        VTEvent::Csi(csi) if csi.final_byte == b'm' => {
            println!("SGR sequence: {:?}", csi.params);
        }
        VTEvent::Raw(text) => {
            println!("Text: {}", String::from_utf8_lossy(text));
        }
        _ => {}
    }
});