Struct EncodeRequest 

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

An encoding request — binds config + image dimensions + pixel layout.

Created via LosslessConfig::encode_request or LossyConfig::encode_request.

Implementations

impl<'a> EncodeRequest<'a>

pub fn with_metadata(self, meta: &'a ImageMetadata<'a>) -> Self

Attach image metadata (ICC, EXIF, XMP).

pub fn with_limits(self, limits: &'a Limits) -> Self

Attach resource limits.

pub fn with_stop(self, stop: &'a dyn Stop) -> Self

Attach a cooperative cancellation token.

The encoder will check this periodically and return EncodeError::Cancelled if stopped.

pub fn with_source_gamma(self, gamma: f32) -> Self

Specify that source pixels use a custom gamma transfer function.

When set, the encoder linearizes u8/u16 pixels with pixel ^ (1/gamma) instead of the sRGB transfer function, and writes have_gamma=true in the JXL header. This matches cjxl’s behavior for PNGs with gAMA chunks.

Example: 0.45455 for standard gamma 2.2 encoding (gAMA=45455).

pub fn with_color_encoding(self, ce: ColorEncoding) -> Self

Override the color encoding written to the JXL header.

When set, this color encoding is used instead of the default (sRGB for u8/u16, linear sRGB for f32) or any gamma derived from with_source_gamma.

Use this for HDR content (PQ, HLG) or non-sRGB primaries (BT.2020, Display P3).

Note: this only affects the signaled color encoding in the JXL header. Pixel linearization for lossy encoding is still controlled by with_source_gamma(). For float input, pixels are assumed already linear.

pub fn encode(self, pixels: &[u8]) -> Result<Vec<u8>>

Encode pixels and return the JXL bytes.

pub fn encode_with_stats(self, pixels: &[u8]) -> Result<EncodeResult>

Encode pixels and return the JXL bytes together with EncodeStats.

pub fn encode_into( self, pixels: &[u8], out: &mut Vec<u8>, ) -> Result<EncodeResult>

Encode pixels, appending to an existing buffer. Returns metrics.

pub fn encode_to(self, pixels: &[u8], dest: impl Write) -> Result<EncodeResult>

Encode pixels, writing to a std::io::Write destination. Returns metrics.