Struct J2kFileWrapOptions 

pub struct J2kFileWrapOptions<'a> {
    pub payload_kind: CompressedPayloadKind,
    pub color: J2kFileColorSpec<'a>,
    pub color_specs: &'a [J2kFileColorSpec<'a>],
    pub metadata: J2kFileBoxMetadata<'a>,
}

Options for wrapping a raw JPEG 2000 / HTJ2K codestream as a JP2/JPH file.

Fields

payload_kind: CompressedPayloadKind

Desired file wrapper.

color: J2kFileColorSpec<'a>

Color metadata to place in the JP2 Header box.

color_specs: &'a [J2kFileColorSpec<'a>]

Explicit Colour Specification boxes to place in the JP2 Header box.

When non-empty, these are written in order and Self::color is used only for legacy single-COLR callers.

metadata: J2kFileBoxMetadata<'a>

Optional JP2/JPH file metadata boxes to place in the JP2 Header box.

Implementations

impl J2kFileWrapOptions<'_>

pub const fn jp2() -> Self

Create standard JP2 wrapper options.

pub const fn jph() -> Self

Create standard JPH wrapper options for an HTJ2K codestream.

impl<'a> J2kFileWrapOptions<'a>

pub const fn with_color(self, color: J2kFileColorSpec<'a>) -> Self

Return options with explicit color metadata.

pub const fn with_color_specs( self, color_specs: &'a [J2kFileColorSpec<'a>], ) -> Self

Return options with explicit ordered JP2/JPH Colour Specification boxes.

pub const fn with_metadata(self, metadata: J2kFileBoxMetadata<'a>) -> Self

Return options with explicit JP2/JPH metadata boxes.

Trait Implementations

impl<'a> Clone for J2kFileWrapOptions<'a>

fn clone(&self) -> J2kFileWrapOptions<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for J2kFileWrapOptions<'a>

impl<'a> Debug for J2kFileWrapOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for J2kFileWrapOptions<'a>

impl<'a> PartialEq for J2kFileWrapOptions<'a>

fn eq(&self, other: &J2kFileWrapOptions<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for J2kFileWrapOptions<'a>