commit	93df23bc48924813fdaf3cf7173707b7c4479695	[log] [tgz]
author	James Farrell <[email protected]>	Wed Aug 14 19:03:24 2024 +0000
committer	Automerger Merge Worker <[email protected]>	Wed Aug 14 19:03:24 2024 +0000
tree	0f15a998d6237d5a38423bc8abf73910c0c6171f
parent	f051ed7e0ca85148f146d5005f51db9bd1b43976 [diff]
parent	127a2ec54edf25e6ff1071a8ed073a14ec4923ff [diff]

tree: 0f15a998d6237d5a38423bc8abf73910c0c6171f

README.md

LOC

ANSI Escape Sequences provider & parser

A Rust library which provides an ANSI escape sequences (or codes, whatever you like more) and a parser allowing you to parse data from the STDIN (or /dev/tty) in the raw mode.

Sequences provider

Terminal support

Not all ANSI escape sequences are supported by all terminals. You can use the interactive-test to test them. Checkout the repository and then:

$ cd anes-rs
$ cargo run --bin interactive-test

Examples

[dependencies]
anes = "0.1"

An example how to retrieve the ANSI escape sequence as a String:

use anes::SaveCursorPosition;

fn main() {
    let string = format!("{}", SaveCursorPosition);
    assert_eq!(&string, "\x1B7");
}

An example how to use the ANSI escape sequence:

use std::io::{Result, Write};

use anes::execute;

fn main() -> Result<()> {
    let mut stdout = std::io::stdout();
    execute!(
        &mut stdout,
        anes::SaveCursorPosition,
        anes::MoveCursorTo(10, 10),
        anes::RestoreCursorPosition
    )?;
    Ok(())
}

Sequences parser

You have to enable parser feature in order to use the parser. It's disabled by default.

Examples

[dependencies]
anes = { version = "0.1", features = ["parser"] }

An example how to parse cursor position:

use anes::parser::{Parser, Sequence};

let mut parser = Parser::default();
parser.advance(b"\x1B[20;10R", false);

assert_eq!(Some(Sequence::CursorPosition(10, 20)), parser.next());
assert!(parser.next().is_none());

License

The ANES crate is dual-licensed under Apache 2.0 and MIT terms.

Copyrights in the ANES project are retained by their contributors. No copyright assignment is required to contribute to the ANES project.