Struct repng::Encoder

pub struct Encoder<W, F> { /* fields omitted */ }

The main object, which does all of the encoding work.

Methods

impl<W: Write, F> Encoder<W, F>

pub fn new(opts: &Options, sink: W, filter: F) -> Result<Self>

Make a new encoder, which writes to a given sink, with a custom filter.

This method also immediately writes the PNG headers to the sink.

pub fn finish(self) -> Result<W>

Flush the encoder, writing any delayed data, and recover the sink.

pub fn chunk(&mut self, kind: &[u8; 4], data: &[u8]) -> Result<()>

Write a chunk with the given type and data.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn writer(&mut self) -> &mut W

Get access to the writer that this was built with.

Be careful, because you can easily corrupt the image with this method.

pub fn reset(&mut self)

Reset the encoder to encode another image with the exact same options.

impl<W: Write, F: Filter> Encoder<W, F>

pub fn write(&mut self, rows: &[u8]) -> Result<()>

Feed zero or more rows to the encoder.

Rows are specified in top-to-bottom and left-to-right order.

Panics

This method panics if you try to write data that doesn't fit into a whole number of rows.

Trait Implementations