Struct Sixel

pub struct Sixel<'a> {
    pub bytes: Option<&'a [u8]>,
    pub width: i32,
    pub height: i32,
    pub format: PixelFormat,
    pub dither: Dither,
    pub split: SixelSplit,
    pub mean: SixelMean,
    pub quality: SixelQuality,
}

Available on crate feature alloc and crate feature term and (crate features io or std) and (crate features dep_hashbrown or std) and crate feature image only.

A configurable sixel string builder from a slice of pixel data bytes.

By default it assumes RGB888 PixelFormat, and Automatic Dither, SixelSplit, SixelMean and SixelQuality.

Example

// 2x2 pixels (Red, Green, Blue, White)
const IMAGE_HEX: &[u8] = b"FF000000FF000000FFFFFFFF";
//                         RRGGBBrrggbbRRGGBBrrggbb
println!("{}", Sixel::with_bytes_size(IMAGE_HEX, 2, 2).build().unwrap());

Fields

bytes: Option<&'a [u8]>

width: i32

height: i32

format: PixelFormat

dither: Dither

split: SixelSplit

mean: SixelMean

Method for choosing a representative mean color for the box.

quality: SixelQuality

Implementations

impl<'bytes> Sixel<'bytes>

Common methods

pub const fn new() -> Self

Returns a new empty sixel builder.

pub const fn with_bytes(bytes: &'bytes [u8]) -> Self

Returns a new empty sixel builder with the given byte slice.

pub const fn with_size(width: i32, height: i32) -> Self

Returns a new empty sixel builder with the given size.

pub const fn with_bytes_size( bytes: &'bytes [u8], width: i32, height: i32, ) -> Self

Returns a new empty sixel builder with the given byte slize and size.

pub fn build(self) -> Result<String, SixelError>

Builds a sixel formatted string with the configured options.

Errors

Returns an error if the bytes slice have not been set, if either the width or height is 0, or the slice is not long enough.

pub const fn bytes(self, bytes: &'bytes [u8]) -> Self

Sets the byte slice of image data.

pub const fn width(self, width: i32) -> Self

Sets the width.

pub const fn height(self, height: i32) -> Self

Sets the height.

pub const fn size(self, width: i32, height: i32) -> Self

Sets the size (width, height).

pub const fn format(self, format: PixelFormat) -> Self

Sets the pixel format.

pub const fn dither(self, dither: Dither) -> Self

Sets the method for dither diffusion.

pub const fn split(self, split: SixelSplit) -> Self

Sets the method for largest dimension for splitting.

pub const fn mean(self, mean: SixelMean) -> Self

Sets the method for mean.

pub const fn quality(self, quality: SixelQuality) -> Self

Sets the quality.

impl Sixel<'_>

Extra methods

pub const fn format_rgb555(self) -> Self

Sets the format field to PixelFormat::RGB555.

pub const fn format_rgb565(self) -> Self

Sets the format field to PixelFormat::RGB565.

pub const fn format_rgb888(self) -> Self

Sets the format field to PixelFormat::RGB888.

pub const fn format_bgr555(self) -> Self

Sets the format field to PixelFormat::BGR555.

pub const fn format_bgr565(self) -> Self

Sets the format field to PixelFormat::BGR565.

pub const fn format_bgr888(self) -> Self

Sets the format field to PixelFormat::BGR888.

pub const fn format_argb8888(self) -> Self

Sets the format field to PixelFormat::ARGB8888.

pub const fn format_rgba8888(self) -> Self

Sets the format field to PixelFormat::RGBA8888.

pub const fn format_abgr8888(self) -> Self

Sets the format field to PixelFormat::ABGR8888.

pub const fn format_bgra8888(self) -> Self

Sets the format field to PixelFormat::BGRA8888.

pub const fn format_g1(self) -> Self

Sets the format field to PixelFormat::G1.

pub const fn format_g2(self) -> Self

Sets the format field to PixelFormat::G2.

pub const fn format_g4(self) -> Self

Sets the format field to PixelFormat::G4.

pub const fn format_g8(self) -> Self

Sets the format field to PixelFormat::G8.

pub const fn format_ag88(self) -> Self

Sets the format field to PixelFormat::AG88.

pub const fn format_ga88(self) -> Self

Sets the format field to PixelFormat::GA88.

pub const fn format_pal1(self) -> Self

Sets the format field to PixelFormat::PAL1.

pub const fn format_pal2(self) -> Self

Sets the format field to PixelFormat::PAL2.

pub const fn format_pal4(self) -> Self

Sets the format field to PixelFormat::PAL4.

pub const fn format_pal8(self) -> Self

Sets the format field to PixelFormat::PAL8.

pub const fn split_auto(self) -> Self

Sets the split field to SixelSplit::Auto.

pub const fn split_norm(self) -> Self

Sets the split field to SixelSplit::Norm.

pub const fn split_lum(self) -> Self

Sets the split field to SixelSplit::Lum.

pub const fn mean_auto(self) -> Self

Sets the mean field to SixelMean::Auto.

pub const fn mean_center(self) -> Self

Sets the mean field to SixelMean::Center.

pub const fn mean_colors(self) -> Self

Sets the mean field to SixelMean::Colors.

pub const fn mean_pixels(self) -> Self

Sets the mean field to SixelMean::Pixels.

pub const fn dither_auto(self) -> Self

Sets the dither field to Dither::Auto.

pub const fn dither_none(self) -> Self

Sets the dither field to Dither::None.

pub const fn dither_atkinson(self) -> Self

Sets the dither field to Dither::Atkinson.

pub const fn dither_fs(self) -> Self

Sets the dither field to Dither::FS.

pub const fn dither_jajuni(self) -> Self

Sets the dither field to Dither::JaJuNi.

pub const fn dither_stucki(self) -> Self

Sets the dither field to Dither::Stucki.

pub const fn dither_burkes(self) -> Self

Sets the dither field to Dither::Burkes.

pub const fn dither_adither(self) -> Self

Sets the dither field to Dither::ADither.

pub const fn dither_xdither(self) -> Self

Sets the dither field to Dither::XDither.

pub const fn quality_auto(self) -> Self

Sets the quality field to SixelQuality::Auto.

pub const fn quality_high(self) -> Self

Sets the quality field to SixelQuality::High.

pub const fn quality_low(self) -> Self

Sets the quality field to SixelQuality::Low.

pub const fn quality_full(self) -> Self

Sets the quality field to SixelQuality::Full.

pub const fn quality_high_color(self) -> Self

Sets the quality field to SixelQuality::HighColor.

Trait Implementations

impl<'a> Clone for Sixel<'a>

fn clone(&self) -> Sixel<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConstDefault for Sixel<'_>

const DEFAULT: Self

Returns the compile-time “default value” for a type.

impl<'a> Debug for Sixel<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for Sixel<'a>

fn default() -> Sixel<'a>

Returns the “default value” for a type.

impl<'a> Hash for Sixel<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Sixel<'a>

fn eq(&self, other: &Sixel<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Sixel<'a>

impl<'a> StructuralPartialEq for Sixel<'a>