Struct ImageBuffer 

pub struct ImageBuffer { /* private fields */ }

A decoded, fully validated container image owned as a flat byte buffer.

The type deliberately does not implement Clone. Container images are several megabytes large, and an accidental copy would leave a second image in memory that no layer is responsible for wiping.

Implementations

impl ImageBuffer

pub fn envelope(&self) -> &PngEnvelope

The shape of the file these samples were read from.

What the writing side reproduces, and the only description of the container that is about the file rather than about the pixels. See crate::image_io::envelope for what is copied out of it and what is deliberately left behind.

Trait Implementations

impl CoverSource for ImageBuffer

fn dimensions(&self) -> (u32, u32)

Image dimensions as (width, height), in pixels.

fn pixels(&self) -> &[u8]

Raw sample bytes in row-major order.

fn pixels_mut(&mut self) -> &mut [u8]

Mutable view of the raw sample bytes, used by the embedding layer.

fn color_space(&self) -> ColorSpace

Pixel layout of the underlying samples.

fn pixel_count(&self) -> usize

Total number of pixels in the image.

fn pixel_offset(&self, x: u32, y: u32) -> usize

Byte offset of the first sample of the pixel at (x, y).

impl Debug for ImageBuffer

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

Formats the value using the given formatter.

impl Zeroize for ImageBuffer

fn zeroize(&mut self)

Overwrites the sample buffer in place.

Written by hand rather than derived: only pixels holds data worth wiping, whereas the derive would also reset the dimensions, which are metadata a caller may still need while inspecting the wiped buffer.