fitskit 0.2.0

Pure Rust FITS v4.0 reader/writer with tile-compression read and write
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

use std::fmt;
use std::io;

/// All errors produced by this crate.
#[derive(Debug)]
pub enum Error {
    Io(io::Error),
    InvalidFormat(String),
    InvalidKeyword(String),
    UnsupportedBitpix(i64),
    MissingKeyword(String),
    KeywordTypeMismatch(String),
    DataSizeMismatch { expected: usize, actual: usize },
    ChecksumMismatch { expected: u32, actual: u32 },
    UnsupportedExtension(String),
    InvalidTableFormat(String),
    UnsupportedCompression(String),
    CompressionError(String),
    /// A WCS header is malformed or incomplete (missing keyword, inconsistent
    /// CTYPE, etc.). Only produced with the `wcs` feature.
    Wcs(String),
    /// A WCS feature is recognised but unsupported (SIP, unknown projection
    /// code, non-degree units, etc.). Only produced with the `wcs` feature.
    UnsupportedWcs(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Io(e) => write!(f, "I/O error: {e}"),
            Error::InvalidFormat(s) => write!(f, "invalid FITS format: {s}"),
            Error::InvalidKeyword(s) => write!(f, "invalid keyword: {s}"),
            Error::UnsupportedBitpix(b) => write!(f, "unsupported BITPIX value: {b}"),
            Error::MissingKeyword(s) => write!(f, "missing required keyword: {s}"),
            Error::KeywordTypeMismatch(s) => write!(f, "keyword type mismatch: {s}"),
            Error::DataSizeMismatch { expected, actual } => {
                write!(f, "data size mismatch: expected {expected}, got {actual}")
            }
            Error::ChecksumMismatch { expected, actual } => {
                write!(
                    f,
                    "checksum mismatch: expected {expected:#010x}, got {actual:#010x}"
                )
            }
            Error::UnsupportedExtension(s) => write!(f, "unsupported extension: {s}"),
            Error::InvalidTableFormat(s) => write!(f, "invalid table format: {s}"),
            Error::UnsupportedCompression(s) => write!(f, "unsupported compression: {s}"),
            Error::CompressionError(s) => write!(f, "compression error: {s}"),
            Error::Wcs(s) => write!(f, "invalid WCS: {s}"),
            Error::UnsupportedWcs(s) => write!(f, "unsupported WCS: {s}"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::Io(e) => Some(e),
            _ => None,
        }
    }
}

impl From<io::Error> for Error {
    fn from(e: io::Error) -> Self {
        Error::Io(e)
    }
}

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