Struct DecodeParms

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

Writer for an filter decode parameters dictionary.

This struct is created by Stream::decode_parms.

Implementations

impl DecodeParms<'_>

Properties for FlateDecode and LzwDecode.

pub fn predictor(&mut self, predictor: Predictor) -> &mut Self

Write the /Predictor attribute for FlateDecode and LzwDecode.

No predictor is used by default.

pub fn colors(&mut self, colors: i32) -> &mut Self

Write the /Colors attribute for FlateDecode and LzwDecode.

Must be greater than 0. /Predictor must be set. Defaults to 1.

pub fn bits_per_component(&mut self, bits: i32) -> &mut Self

Write the /BitsPerComponent attribute for FlateDecode and LzwDecode.

Must be one of 1, 2, 4, 8, or 16. /Predictor must be set. Defaults to 8.

pub fn columns(&mut self, columns: i32) -> &mut Self

Write the /Columns attribute for FlateDecode and LzwDecode or CcittFaxDecode.

When used with FlateDecode and LzwDecode, it indicates the number of samples in each row. In that case, /Predictor must be set and the default is 1.

When used with CcittFaxDecode it denominates the width of the image in pixels and defaults to 1728.

pub fn early_change(&mut self, early_change: bool) -> &mut Self

Write the /EarlyChange attribute for LzwDecode.

If true (1), the code length increases one code earlier, if false (0), length change is postponed as long as possible.

Defaults to 1.

impl DecodeParms<'_>

Properties for CcittFaxDecode. Also see Self::columns.

pub fn k(&mut self, k: i32) -> &mut Self

Write the /K attribute for CcittFaxDecode.

Defaults to 0.

pub fn end_of_line(&mut self, eol: bool) -> &mut Self

Write the /EndOfLine attribute for CcittFaxDecode.

Whether the EOL bit pattern is present in the encoding. Defaults to false.

pub fn encoded_byte_align(&mut self, encoded_byte_align: bool) -> &mut Self

Write the /EncodedByteAlign attribute for CcittFaxDecode.

Whether to expect zero bits before each encoded line. Defaults to false.

pub fn rows(&mut self, rows: i32) -> &mut Self

Write the /Rows attribute for CcittFaxDecode.

The image’s height. Defaults to 0.

pub fn end_of_block(&mut self, end_of_block: bool) -> &mut Self

Write the /EndOfBlock attribute for CcittFaxDecode.

Whether to expect an EOB code at the end of the data. Defaults to true.

pub fn black_is_1(&mut self, black_is_1: bool) -> &mut Self

Write the /BlackIs1 attribute for CcittFaxDecode.

Whether to invert the bits in the image. Defaults to false.

pub fn damaged_rows_before_error(&mut self, count: i32) -> &mut Self

Write the /DamagedRowsBeforeError attribute for CcittFaxDecode.

How many damaged rows are allowed before an error is raised. Defaults to 0.

impl DecodeParms<'_>

Properties for Jbig2Decode.

pub fn jbig2_globals(&mut self, globals: Ref) -> &mut Self

Write the /JBIG2Globals attribute for Jbig2Decode.

A reference to a stream containing global segments.

impl DecodeParms<'_>

Properties for JpxDecode.

pub fn color_transform(&mut self, color_transform: bool) -> &mut Self

Write the /ColorTransform attribute for JpxDecode.

How to handle color data. If true (1), images with three color channels shall be decoded from the YCbCr space and images with four color channels are decoded from YCbCrK. If false (0), no transformation is applied. The default depends on the APP14 marker in the data stream.

impl DecodeParms<'_>

Properties for Crypt.

pub fn crypt_type(&mut self) -> &mut Self

Write the /Type attribute for Crypt as CryptFilterDecodeParms.

pub fn name(&mut self, name: Name<'_>) -> &mut Self

Write the /Name attribute for Crypt.

The name of the crypt filter corresponding to a CF entry of the encryption dictionary.

Methods from Deref<Target = Dict<'a>>

pub fn len(&self) -> i32

The number of written pairs.

pub fn is_empty(&self) -> bool

Whether no pairs have been written so far.

pub fn insert(&mut self, key: Name<'_>) -> Obj<'_>

Start writing a pair with an arbitrary value.

pub fn pair<T: Primitive>(&mut self, key: Name<'_>, value: T) -> &mut Self

Write a pair with a primitive value.

This is a shorthand for dict.insert(key).primitive(value).

pub fn pairs<'n, T: Primitive>( &mut self, pairs: impl IntoIterator<Item = (Name<'n>, T)>, ) -> &mut Self

Write a sequence of pairs with primitive values.

Trait Implementations

impl<'a> Deref for DecodeParms<'a>

type Target = Dict<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> DerefMut for DecodeParms<'a>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, 'any> Rewrite<'a> for DecodeParms<'any>

type Output = DecodeParms<'a>

The writer with the rewritten lifetime.

impl<'a> Writer<'a> for DecodeParms<'a>

fn start(obj: Obj<'a>) -> Self

Start writing the object.