Skip to main content

fits_header/
lib.rs

1// The crate root page is the README verbatim (also compiled as doctests below), so
2// docs.rs's landing page is the full pitch, not just this comment.
3#![doc = include_str!("../README.md")]
4#![forbid(unsafe_code)]
5
6mod dates;
7mod error;
8mod header;
9mod key;
10mod parse;
11mod record;
12mod value;
13mod write;
14
15// Source of truth: docs/guide.md — also linked from the README and run via
16// `cargo run --example quickstart`; its code blocks are compiled as doctests here.
17#[doc = include_str!("../docs/guide.md")]
18pub mod guide {}
19
20/// Bytes per header card.
21pub const CARD_LEN: usize = 80;
22/// Bytes per FITS block (36 cards).
23pub const BLOCK_LEN: usize = 2880;
24
25pub use crate::dates::{format_datetime, parse_datetime};
26pub use crate::error::{FitsError, Result};
27pub use crate::header::Header;
28pub use crate::key::Key;
29#[allow(deprecated)]
30pub use crate::parse::parse;
31pub use crate::record::{Record, RecordKind, Value};
32pub use crate::value::{parse_f64, parse_i64, Fixed, FromCard, IntoValue, Literal, Sci};