Enum ProcessedImage 

pub enum ProcessedImage {
    Color(RgbaImage),
    Color2(RgbImage),
    NoColor(GrayImage),
    Both(RgbaImage, GrayImage),
}

Represents an image that has been processed for display purposes

Variants

Color(RgbaImage)

A color image represented as RGBA pixels

Color2(RgbImage)

A color image represented as RGB pixels, available only when sixel feature is enabled

NoColor(GrayImage)

A grayscale/luminance image

Both(RgbaImage, GrayImage)

Both color (RGBA) and grayscale (Gray) representations of the same image

Implementations

impl ProcessedImage

pub fn new(mode: DisplayMode, img: &DynamicImage) -> Self

Create a new ProcessedImage based on the display mode and source image

This method converts the input DynamicImage into the appropriate format(s) required by the specified DisplayMode.

Arguments

• mode - The DisplayMode that determines how the image should be processed
• img - The source DynamicImage to process

Returns

A ProcessedImage variant containing the appropriately formatted image data

pub fn rgba(&self) -> Option<&RgbaImage>

Get a reference to the RGBA image data if available

Returns

• Some(&RgbaImage) - If the processed image contains RGBA data (Color or Both variants)
• None - If the processed image only contains grayscale data (NoColor variant)

pub fn rgb(&self) -> Option<&RgbImage>

Get a reference to the RGB image data if available

Available only when the sixel feature is enabled.

Returns

• Some(&RgbImage) - If the processed image contains RGB data (Color2 variant)
• None - For other variants

pub fn luma(&self) -> Option<&GrayImage>

Get a reference to the grayscale image data if available

Returns

• Some(&GrayImage) - If the processed image contains grayscale data (NoColor or Both variants)
• None - Should not occur in normal usage

pub fn both(&self) -> Option<(&RgbaImage, &GrayImage)>

Get references to both RGBA and grayscale image data if available

Returns

• Some((&RgbaImage, &GrayImage)) - If the processed image contains both formats (Both variant)
• None - For other variants

pub fn is_color(&self) -> bool

Check if the processed image contains color data

Returns

• true - If the processed image only color data (Color variants)
• false - If the processed image contains grayscale data (NoColor variant)

pub fn is_no_color(&self) -> bool

Check if the processed image contains no color data (grayscale only)

Returns

• true - If the processed image contains only grayscale data (NoColor variant)
• false - If the processed image contains color data (Color, Color2, or Both variants)

pub fn is_both(&self) -> bool

Check if the processed image contains both color and grayscale data

Returns

• true - If the processed image contains both color and grayscale data (Both variant)
• false - If the processed image contains only color or only grayscale data

pub fn is_color2(&self) -> bool

Check if the processed image contains RGB color data (available only when sixel feature is enabled)

Returns

• true - If the processed image contains RGB color data (Color2 variant)
• false - If the processed image contains other data types

pub fn mode(&self) -> &'static str

Get the name of the processed image variant

Returns

A static string slice representing the variant name:

• “Color” - For RGBA image data
• “Color2” - For RGB image data (when sixel feature is enabled)
• “NoColor” - For grayscale image data
• “Both” - For images containing both RGBA and grayscale data

Trait Implementations

impl Clone for ProcessedImage

fn clone(&self) -> ProcessedImage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessedImage

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

Formats the value using the given formatter.

impl PartialEq for ProcessedImage

fn eq(&self, other: &ProcessedImage) -> 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 StructuralPartialEq for ProcessedImage