tiff-reader 0.3.1

Pure-Rust, read-only TIFF/BigTIFF file decoder with no C dependencies
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use thiserror::Error;
use tiff_core::Compression;

pub type Result<T> = std::result::Result<T, Error>;

#[derive(Debug, Error)]
pub enum Error {
    #[error("I/O error reading {1}: {0}")]
    Io(#[source] std::io::Error, String),

    #[error("not a TIFF file: invalid magic bytes")]
    InvalidMagic,

    #[error("unsupported TIFF version: {0}")]
    UnsupportedVersion(u16),

    #[error("IFD index {0} not found")]
    IfdNotFound(usize),

    #[error("tag {0} not found in IFD")]
    TagNotFound(u16),

    #[error("unexpected tag type {actual} for tag {tag}, expected {expected}")]
    UnexpectedTagType {
        tag: u16,
        expected: &'static str,
        actual: u16,
    },

    #[error(
        "unsupported compression: {name} ({0})",
        name = unsupported_compression_name(*.0)
    )]
    UnsupportedCompression(u16),

    #[error("unsupported predictor: {0}")]
    UnsupportedPredictor(u16),

    #[error("unsupported planar configuration: {0}")]
    UnsupportedPlanarConfiguration(u16),

    #[error("unsupported bits per sample: {0}")]
    UnsupportedBitsPerSample(u16),

    #[error("unsupported sample format: {0}")]
    UnsupportedSampleFormat(u16),

    #[error("decompression failed for strip/tile {index}: {reason}")]
    DecompressionFailed { index: usize, reason: String },

    #[error("data truncated at offset {offset}: need {needed} bytes, have {available}")]
    Truncated {
        offset: u64,
        needed: u64,
        available: u64,
    },

    #[error("offset {offset} with length {length} is out of bounds for a {data_len}-byte file")]
    OffsetOutOfBounds {
        offset: u64,
        length: u64,
        data_len: u64,
    },

    #[error("invalid TIFF tag {tag}: {reason}")]
    InvalidTagValue { tag: u16, reason: String },

    #[error("invalid image layout: {0}")]
    InvalidImageLayout(String),

    #[error("type mismatch: expected {expected}, found {actual}")]
    TypeMismatch {
        expected: &'static str,
        actual: String,
    },

    #[error("{0}")]
    Other(String),
}

fn unsupported_compression_name(code: u16) -> &'static str {
    Compression::from_code(code)
        .map(Compression::name)
        .unwrap_or("unknown")
}