#sixel #serializer-deserializer #data #sixel-image

sixel-image

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

1 unstable release

0.1.0 Jul 7, 2022

#859 in Images

Download history 137/week @ 2024-12-08 6630/week @ 2024-12-15 11926/week @ 2024-12-22 758/week @ 2024-12-29 865/week @ 2025-01-05 826/week @ 2025-01-12 933/week @ 2025-01-19 787/week @ 2025-01-26 996/week @ 2025-02-02 1378/week @ 2025-02-09 1035/week @ 2025-02-16 1050/week @ 2025-02-23 926/week @ 2025-03-02 1037/week @ 2025-03-09 2213/week @ 2025-03-16 1106/week @ 2025-03-23

5,401 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.4–0.9MB
~20K SLoC