Struct Configuration

pub struct Configuration {
    order: BitOrder,
    size: u8,
    tiff: bool,
    yield_on_full: bool,
}

Describes the static parameters for creating a decoder.

Fields

order: BitOrder

size: u8

tiff: bool

yield_on_full: bool

Implementations

impl Configuration

pub fn new(order: BitOrder, size: u8) -> Self

Create a configuration to decode with the specified bit order and symbol size.

pub fn with_tiff_size_switch(order: BitOrder, size: u8) -> Self

Create a configuration for a TIFF compatible decoder.

pub fn with_yield_on_full_buffer(self, do_yield: bool) -> Self

Immediately yield to the caller when the decoder buffer is full.

This can be used for libtiff compatibility. It will use a “relaxed” stream interpretation that need not contain an explicit EOF. Instead, the decoder is expected to stop fetching symbols when some out-of-band specified length of the decoded text has been reached. The caller indicates this maximum length through the available output buffer space.

Symbols afterwards must not be expected to be valid. On filling the output buffer space completely, the decoder will return immediately to the caller instead of potentially interpreting the following bit-stream (and returning an error on doing so).

Default: false.

pub fn build(self) -> Decoder

Create a new decoder with the define configuration.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.