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

sixel-image

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

1 unstable release

0.1.0 Jul 7, 2022

#2570 in Encoding

Download history 1787/week @ 2024-11-15 914/week @ 2024-11-22 825/week @ 2024-11-29 347/week @ 2024-12-06 532/week @ 2024-12-13 17796/week @ 2024-12-20 781/week @ 2024-12-27 826/week @ 2025-01-03 830/week @ 2025-01-10 932/week @ 2025-01-17 823/week @ 2025-01-24 954/week @ 2025-01-31 998/week @ 2025-02-07 1388/week @ 2025-02-14 1046/week @ 2025-02-21 835/week @ 2025-02-28

4,415 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

~330–780KB
~18K SLoC