Struct Encoder 

pub struct Encoder<'a> { /* private fields */ }

Encode QOI images into buffers or into streams.

Implementations

impl<'a> Encoder<'a>

pub fn new( data: &'a (impl AsRef<[u8]> + ?Sized), width: u32, height: u32, ) -> Result<Self>

Creates a new encoder from a given array of pixel data and image dimensions. The data must be in RGB(A) order, without fill borders (extra stride).

The number of channels will be inferred automatically (the valid values are 3 or 4). The color space will be set to sRGB by default.

pub const fn with_colorspace(self, colorspace: ColorSpace) -> Self

Returns a new encoder with modified color space.

Note: the color space doesn’t affect encoding or decoding in any way, it’s a purely informative field that’s stored in the image header.

pub const fn channels(&self) -> Channels

Returns the inferred number of channels.

pub const fn header(&self) -> &Header

Returns the header that will be stored in the encoded image.

pub fn required_buf_len(&self) -> usize

The maximum number of bytes the encoded image will take.

Can be used to pre-allocate the buffer to encode the image into.

pub fn encode_to_buf(&self, buf: impl AsMut<[u8]>) -> Result<usize>

Encodes the image to a pre-allocated buffer and returns the number of bytes written.

The minimum size of the buffer can be found via Encoder::required_buf_len.

pub fn encode_to_vec(&self) -> Result<Vec<u8>>

Encodes the image into a newly allocated vector of bytes and returns it.

pub fn encode_to_stream<W: Write>(&self, writer: &mut W) -> Result<usize>

Encodes the image directly to a generic writer that implements Write.

Note: while it’s possible to pass a &mut [u8] slice here since it implements Write, it would more effficient to use a specialized method instead: Encoder::encode_to_buf.