#sixel #data #interface #querying #manipulating #byte #serializing-deserializing

sixel-image

An interface for querying, manipulating and serializing/deserializing Sixel data

1 unstable release

0.1.0 Jul 7, 2022

#1136 in Encoding

Download history 557/week @ 2023-12-06 545/week @ 2023-12-13 444/week @ 2023-12-20 520/week @ 2023-12-27 608/week @ 2024-01-03 695/week @ 2024-01-10 633/week @ 2024-01-17 623/week @ 2024-01-24 815/week @ 2024-01-31 680/week @ 2024-02-07 673/week @ 2024-02-14 959/week @ 2024-02-21 891/week @ 2024-02-28 696/week @ 2024-03-06 667/week @ 2024-03-13 542/week @ 2024-03-20

2,941 downloads per month
Used in 2 crates (via zellij-server)

MIT license

31KB
718 lines

sixel-image

This library provides an interface for querying, manipulating and serializing/deserializing sixel data.

There are several methods provided here to do this:

  1. If you already have all the serialized sixel bytes, construct SixelImage directly
  2. If you'd like to parse bytes in real time "on the wire", use SixelDeserializer (accompanied by the sixel-tokenizer sister crate).

Example

With all the serialized bytes ahead of time (option 1)

use sixel_image::SixelImage;

fn main() {
    let sample = "
        \u{1b}Pq
        \"2;1;100;200
        #0;2;0;0;0#1;2;100;100;0#2;2;0;100;0
        #1~~@@vv@@~~@@~~$
        #2??}}GG}}??}}??-
        #1!14@
        \u{1b}\\
    ";
    let bytes = sample.as_bytes();

    let sixel_image = SixelImage::new(&bytes).unwrap();
    let serialized = sixel_image.serialize();
    println!("{:?}", serialized);
}

Parsing bytes "on the wire" (option 2)

use sixel_tokenizer::Parser;
use sixel_image::SixelDeserializer;

fn main() {
    let sample = "
        \u{1b}Pq
        \"2;1;100;200
        #0;2;0;0;0#1;2;100;100;0#2;2;0;100;0
        #1~~@@vv@@~~@@~~$
        #2??}}GG}}??}}??-
        #1!14@
        \u{1b}\\
    ";
    let bytes = sample.as_bytes();
    let mut parser = Parser::new();
    let mut sixel_deserializer = SixelDeserializer::new();
    for byte in bytes {
        parser.advance(&byte, |sixel_event| {
            let _ = sixel_deserializer.handle_event(sixel_event);
        });
    }
    let sixel_image = sixel_deserializer.create_image().unwrap();
    let serialized = sixel_image.serialize();
    println!("{:?}", serialized);
}

License

MIT

Dependencies

~0.5–1MB
~23K SLoC