Struct image::codecs::pnm::PnmHeader

pub struct PnmHeader {
    pub(crate) decoded: HeaderRecord,
    pub(crate) encoded: Option<Vec<u8>>,
}

Stores the complete header data of a file.

Internally, provides mechanisms for lossless reencoding. After reading a file with the decoder it is possible to recover the header and construct an encoder. Using the encoder on the just loaded image should result in a byte copy of the original file (for single image pnms without additional trailing data).

Fields

decoded: HeaderRecord

encoded: Option<Vec<u8>>

Implementations

impl PnmHeader

pub fn subtype(&self) -> PnmSubtype

Retrieve the format subtype from which the header was created.

pub fn width(&self) -> u32

The width of the image this header is for.

pub fn height(&self) -> u32

The height of the image this header is for.

pub fn maximal_sample(&self) -> u32

The biggest value a sample can have. In other words, the colour resolution.

pub fn as_bitmap(&self) -> Option<&BitmapHeader>

Retrieve the underlying bitmap header if any

pub fn as_graymap(&self) -> Option<&GraymapHeader>

Retrieve the underlying graymap header if any

pub fn as_pixmap(&self) -> Option<&PixmapHeader>

Retrieve the underlying pixmap header if any

pub fn as_arbitrary(&self) -> Option<&ArbitraryHeader>

Retrieve the underlying arbitrary header if any

pub fn write(&self, writer: &mut dyn Write) -> Result<()>

Write the header back into a binary stream

Trait Implementations

impl From<ArbitraryHeader> for PnmHeader

fn from(header: ArbitraryHeader) -> Self

Converts to this type from the input type.

impl From<BitmapHeader> for PnmHeader

fn from(header: BitmapHeader) -> Self

Converts to this type from the input type.

impl From<GraymapHeader> for PnmHeader

fn from(header: GraymapHeader) -> Self

Converts to this type from the input type.

impl From<PixmapHeader> for PnmHeader

fn from(header: PixmapHeader) -> Self

Converts to this type from the input type.