Skip to main content

TiffValue

Trait TiffValue

pub trait TiffValue {
    const BYTE_LEN: u8;
    const FIELD_TYPE: Type;

    // Required methods
    fn count(&self) -> usize;
    fn data(&self) -> Cow<'_, [u8]>;

    // Provided methods
    fn bytes(&self) -> usize { ... }
    fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()> { ... }
}

Expand description

Trait for types that can be encoded in a tiff file

Required Associated Constants§

const BYTE_LEN: u8

const FIELD_TYPE: Type

Required Methods§

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

Access this value as an contiguous sequence of bytes. If their is no trivial representation, allocate it on the heap.

Provided Methods§

fn bytes(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

Write this value to a TiffWriter. While the default implementation will work in all cases, it may require unnecessary allocations. The written bytes of any custom implementation MUST be the same as yielded by self.data().

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

impl TiffValue for f32

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::FLOAT

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for f64

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::DOUBLE

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for i8

const BYTE_LEN: u8 = 1

const FIELD_TYPE: Type = Type::SBYTE

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for i16

const BYTE_LEN: u8 = 2

const FIELD_TYPE: Type = Type::SSHORT

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for i32

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::SLONG

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for i64

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::SLONG8

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for str

const BYTE_LEN: u8 = 1

const FIELD_TYPE: Type = Type::ASCII

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for u8

const BYTE_LEN: u8 = 1

const FIELD_TYPE: Type = Type::BYTE

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for u16

const BYTE_LEN: u8 = 2

const FIELD_TYPE: Type = Type::SHORT

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for u32

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::LONG

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for u64

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::LONG8

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [ExtraSamples]

This is implemented for slices as the ExtraSamples tag takes a count of N.

Use core::slice::from_ref if you really need to write a single element.

See: https://web.archive.org/web/20191120220815/https://www.awaresystems.be/imaging/tiff/tifftags/extrasamples.html

const BYTE_LEN: u8 = <u16 as TiffValue>::BYTE_LEN

const FIELD_TYPE: Type = Type::SHORT

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [SampleFormat]

This is implemented for slices as the SampleFormat tag takes a count of N.

Use core::slice::from_ref if you really need to write a single element.

See: https://web.archive.org/web/20191120220815/https://www.awaresystems.be/imaging/tiff/tifftags/sampleformat.html

const BYTE_LEN: u8 = <u16 as TiffValue>::BYTE_LEN

const FIELD_TYPE: Type = Type::SHORT

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [f32]

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::FLOAT

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [f64]

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::DOUBLE

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [i8]

const BYTE_LEN: u8 = 1

const FIELD_TYPE: Type = Type::SBYTE

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [i16]

const BYTE_LEN: u8 = 2

const FIELD_TYPE: Type = Type::SSHORT

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [i32]

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::SLONG

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [i64]

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::SLONG8

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [u8]

const BYTE_LEN: u8 = 1

const FIELD_TYPE: Type = Type::BYTE

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [u16]

const BYTE_LEN: u8 = 2

const FIELD_TYPE: Type = Type::SHORT

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [u32]

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::LONG

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [u64]

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::LONG8

fn count(&self) -> usize

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [Ifd8]

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::IFD8

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [Ifd]

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::IFD

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [Rational]

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::RATIONAL

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl TiffValue for [SRational]

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::SRATIONAL

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl<T, const N: usize> TiffValue for [T; N]
where [T]: TiffValue,

An array is treated like a slice of the same length.

const BYTE_LEN: u8 = <[T]>::BYTE_LEN

const FIELD_TYPE: Type = <[T]>::FIELD_TYPE

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

impl<T: TiffValue + ?Sized> TiffValue for &T

const BYTE_LEN: u8 = T::BYTE_LEN

const FIELD_TYPE: Type = T::FIELD_TYPE

fn count(&self) -> usize

fn write<W: Write>(&self, writer: &mut TiffWriter<W>) -> TiffResult<()>

fn data(&self) -> Cow<'_, [u8]>

Implementors§

impl TiffValue for CompressionMethod

const BYTE_LEN: u8 = <u16 as TiffValue>::BYTE_LEN

const FIELD_TYPE: Type = Type::SHORT

impl TiffValue for PhotometricInterpretation

const BYTE_LEN: u8 = <u16 as TiffValue>::BYTE_LEN

const FIELD_TYPE: Type = Type::SHORT

impl TiffValue for PlanarConfiguration

const BYTE_LEN: u8 = 2

const FIELD_TYPE: Type = Type::SHORT

impl TiffValue for Predictor

const BYTE_LEN: u8 = <u16 as TiffValue>::BYTE_LEN

const FIELD_TYPE: Type = Type::SHORT

impl TiffValue for ResolutionUnit

const BYTE_LEN: u8 = <u16 as TiffValue>::BYTE_LEN

const FIELD_TYPE: Type = Type::SHORT

impl TiffValue for Ifd8

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::IFD8

impl TiffValue for Ifd

const BYTE_LEN: u8 = 4

const FIELD_TYPE: Type = Type::IFD

impl TiffValue for Rational

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::RATIONAL

impl TiffValue for SRational

const BYTE_LEN: u8 = 8

const FIELD_TYPE: Type = Type::SRATIONAL