Struct image::codecs::pnm::PnmHeader

source ·
pub struct PnmHeader { /* private fields */ }
Expand description

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).

Implementations§

source§

impl PnmHeader

source

pub fn subtype(&self) -> PnmSubtype

Retrieve the format subtype from which the header was created.

source

pub fn width(&self) -> u32

The width of the image this header is for.

source

pub fn height(&self) -> u32

The height of the image this header is for.

source

pub fn maximal_sample(&self) -> u32

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

source

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

Retrieve the underlying bitmap header if any

source

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

Retrieve the underlying graymap header if any

source

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

Retrieve the underlying pixmap header if any

source

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

Retrieve the underlying arbitrary header if any

source

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

Write the header back into a binary stream

Trait Implementations§

source§

impl From<ArbitraryHeader> for PnmHeader

source§

fn from(header: ArbitraryHeader) -> Self

Converts to this type from the input type.
source§

impl From<BitmapHeader> for PnmHeader

source§

fn from(header: BitmapHeader) -> Self

Converts to this type from the input type.
source§

impl From<GraymapHeader> for PnmHeader

source§

fn from(header: GraymapHeader) -> Self

Converts to this type from the input type.
source§

impl From<PixmapHeader> for PnmHeader

source§

fn from(header: PixmapHeader) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
source§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.