Struct TiffEncoder 

pub struct TiffEncoder { /* private fields */ }

Encodes a baseline TIFF.

Implementations

impl TiffEncoder

pub const fn new() -> TiffEncoder

An encoder writing uncompressed strips.

pub fn with_layout(self, layout: TiffLayout) -> Result<TiffEncoder, PixelsError>

An encoder writing the given layout.

Errors

Returns PixelsError::InvalidArgument for a zero-sized layout, or tile dimensions that are not multiples of 16 — which TIFF 6.0 §Section 15 requires and every reader relies on.

pub const fn with_deflate(self, level: Level) -> TiffEncoder

An encoder compressing with Deflate at level.

pub fn from_options(options: &EncodeOptions) -> TiffEncoder

An encoder configured from generic encode options.

TIFF is lossless, so quality is read as compression effort: below the midpoint means store uncompressed and prioritise speed, above it means Deflate at a level scaled from the remaining range.

pub const fn layout(&self) -> TiffLayout

The layout this encoder writes.

Trait Implementations

impl Debug for TiffEncoder

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

Formats the value using the given formatter.

impl Default for TiffEncoder

fn default() -> TiffEncoder

Returns the “default value” for a type.

impl Encoder for TiffEncoder

fn set_exif(&mut self, exif: Option<&[u8]>) -> Result<(), PixelsError>

The block’s descriptive tags and its Exif and GPS directories join the image’s own directory, as TIFF keeps EXIF; layout tags in it are ignored, and IFD1’s thumbnail is dropped.

fn set_icc_profile(&mut self, profile: Option<&[u8]>) -> Result<(), PixelsError>

Embed profile as the image’s ICC colour profile, or write none.

fn set_xmp(&mut self, xmp: Option<&[u8]>) -> Result<(), PixelsError>

Embed xmp, an XMP packet as Decoder::xmp gives it, or write none.

fn set_density(&mut self, density: Option<Density>) -> Result<(), PixelsError>

Record density as the image’s resolution, or write the format’s default.

fn write_header( &mut self, desc: &ImageDescriptor, _sink: &mut dyn Sink, ) -> Result<(), PixelsError>

Begin an image, writing any container header.

fn write_row( &mut self, row: &[u8], _sink: &mut dyn Sink, ) -> Result<(), PixelsError>

Write the next row, top to bottom.

fn finish(&mut self, sink: &mut dyn Sink) -> Result<(), PixelsError>

Finish the image, writing any trailer and flushing the sink.