Struct SixelEncoder 

pub struct SixelEncoder<const MAX_COLORS: usize> { /* private fields */ }

Available on crate feature term only.

🖼️ 🮖 Encoder for Sixel graphics with fixed buffer output

---

^{📍 media/visual/image}

---

Features

Enabling the unsafe_sync and __dbg features defines __LOGGER_sixel_encoder_64_64 for diagnostic output.

Implementations

impl<const MAX_COLORS: usize> SixelEncoder<MAX_COLORS>

Methods

• new
• with_palette
• palette_mut
• encode_rgb

pub const fn new() -> Self

Create a new encoder with empty palette

pub const fn with_palette( width: usize, height: usize, palette: SixelPalette<MAX_COLORS>, ) -> Self

Create encoder with predefined palette

pub const fn palette_mut(&mut self) -> &mut SixelPalette<MAX_COLORS>

Get the palette (mutable)

pub const fn encode_rgb( &mut self, rgb: &[u8], width: usize, height: usize, buf: &mut [u8], ) -> Result<usize, NotEnoughSpace>

Sixel encoding with RLE compression for repeated characters.

• RLE encoding is used when the same sixel character repeats 4 or more times.

impl<const MAX_COLORS: usize> SixelEncoder<MAX_COLORS>

pub const fn write_sixel_start( buf: &mut [u8], width: usize, height: usize, ) -> Result<usize, NotEnoughSpace>

Write sixel sequence start with full raster attributes.

Returns an error if the buffer doesn’t have at least 21 bytes, for good measure.

pub const fn write_sixel_start_simple( buf: &mut [u8], ) -> Result<usize, NotEnoughSpace>

Write sixel sequence start with full raster attributes

pub const fn write_sixel_end(buf: &mut [u8]) -> Result<usize, NotEnoughSpace>

Write sixel sequence end.

Trait Implementations

impl<const MAX_COLORS: usize> Clone for SixelEncoder<MAX_COLORS>

fn clone(&self) -> SixelEncoder<MAX_COLORS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX_COLORS: usize> Debug for SixelEncoder<MAX_COLORS>

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

Formats the value using the given formatter.

impl<const MAX_COLORS: usize> Default for SixelEncoder<MAX_COLORS>

fn default() -> Self

Returns the “default value” for a type.

impl<const MAX_COLORS: usize> Eq for SixelEncoder<MAX_COLORS>

impl<const MAX_COLORS: usize> Hash for SixelEncoder<MAX_COLORS>

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<const MAX_COLORS: usize> PartialEq for SixelEncoder<MAX_COLORS>

fn eq(&self, other: &SixelEncoder<MAX_COLORS>) -> 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<const MAX_COLORS: usize> StructuralPartialEq for SixelEncoder<MAX_COLORS>