Skip to main content

Ifd

Struct Ifd 

Source
pub struct Ifd {
    pub index: Option<usize>,
    /* private fields */
}
Expand description

A parsed Image File Directory (IFD).

Fields§

§index: Option<usize>

Index of this IFD in the top-level chain (0-based), or None when the IFD was reached directly through an explicit offset such as a SubIFD.

Implementations§

Source§

impl Ifd

Source

pub fn offset(&self) -> u64

File offset where this IFD starts.

Source

pub fn tag(&self, code: u16) -> Option<&Tag>

Look up a tag by its code.

Source

pub fn tags(&self) -> &[Tag]

Returns all tags in this IFD.

Source

pub fn width(&self) -> u32

Image width in pixels.

Source

pub fn height(&self) -> u32

Image height in pixels.

Source

pub fn bits_per_sample(&self) -> Result<Vec<u16>>

Bits per sample for each channel, validating the tag encoding.

A missing tag defaults to 1 per the TIFF specification. SHORT values are used directly; BYTE and LONG values written by nonconforming writers are coerced when they fit. Any other tag type is rejected instead of silently falling back to the default.

Source

pub fn compression(&self) -> u16

Compression scheme (1 = none, 5 = LZW, 8 = Deflate, …).

Source

pub fn photometric_interpretation(&self) -> Option<u16>

Photometric interpretation.

Source

pub fn photometric_interpretation_enum( &self, ) -> Option<PhotometricInterpretation>

Typed photometric interpretation, defaulting to MinIsBlack when the TIFF tag is omitted.

Source

pub fn samples_per_pixel(&self) -> u16

Number of samples (bands) per pixel.

Source

pub fn is_tiled(&self) -> bool

Returns true if this IFD uses tiled layout.

Source

pub fn tile_width(&self) -> Option<u32>

Tile width (only for tiled IFDs).

Source

pub fn tile_height(&self) -> Option<u32>

Tile height (only for tiled IFDs).

Source

pub fn rows_per_strip(&self) -> u32

Rows per strip. Defaults to the image height when not present.

Source

pub fn sample_format(&self) -> Result<Vec<u16>>

Sample format for each channel, validating the tag encoding.

A missing tag defaults to 1 (unsigned integer) per the TIFF specification. SHORT values are used directly; BYTE and LONG values written by nonconforming writers are coerced when they fit. Any other tag type is rejected instead of silently falling back to the default.

Source

pub fn planar_configuration(&self) -> u16

Planar configuration. Defaults to chunky (1).

Source

pub fn predictor(&self) -> u16

Predictor. Defaults to no predictor (1).

Source

pub fn lerc_parameters(&self) -> Result<Option<LercParameters>>

TIFF-side LERC parameters, when present.

Source

pub fn extra_samples(&self) -> Result<Vec<ExtraSample>>

TIFF ExtraSamples semantics.

Source

pub fn color_map(&self) -> Result<Option<ColorMap>>

TIFF ColorMap values for palette images.

Source

pub fn ink_set(&self) -> Result<Option<InkSet>>

TIFF InkSet semantics for separated photometric data.

Source

pub fn ycbcr_subsampling(&self) -> Result<Option<[u16; 2]>>

TIFF YCbCr chroma subsampling factors.

Source

pub fn ycbcr_positioning(&self) -> Result<Option<YCbCrPositioning>>

TIFF YCbCr sample positioning.

Source

pub fn reference_black_white(&self) -> Result<Option<[f64; 6]>>

TIFF ReferenceBlackWhite values normalized to f64.

Source

pub fn color_model(&self) -> Result<ColorModel>

Structured color-model metadata synthesized from TIFF photometric and ancillary color tags.

Source

pub fn strip_offsets(&self) -> Option<Vec<u64>>

Strip offsets as normalized u64s.

Source

pub fn strip_byte_counts(&self) -> Option<Vec<u64>>

Strip byte counts as normalized u64s.

Source

pub fn tile_offsets(&self) -> Option<Vec<u64>>

Tile offsets as normalized u64s.

Source

pub fn tile_byte_counts(&self) -> Option<Vec<u64>>

Tile byte counts as normalized u64s.

Source

pub fn sub_ifd_offsets(&self) -> Option<Vec<u64>>

SubIFD offsets as normalized u64s.

Source

pub fn raster_layout(&self) -> Result<RasterLayout>

Normalize and validate the raster layout for typed reads.

Source

pub fn decoded_raster_layout(&self) -> Result<RasterLayout>

Normalize the raster layout produced by high-level pixel reads.

This layout reflects color-decoded output rather than the on-disk sample organization. For example, palette and YCbCr rasters decode to RGB pixels, and sub-byte integer rasters expand to 8-bit samples.

Trait Implementations§

Source§

impl Clone for Ifd

Source§

fn clone(&self) -> Ifd

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Ifd

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Ifd

§

impl RefUnwindSafe for Ifd

§

impl Send for Ifd

§

impl Sync for Ifd

§

impl Unpin for Ifd

§

impl UnsafeUnpin for Ifd

§

impl UnwindSafe for Ifd

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.