Struct FitsWriter 

pub struct FitsWriter<W> { /* private fields */ }

Writes FITS HDUs to a byte sink. The first HDU written becomes the primary array; subsequent images/tables are written as extensions.

Implementations

impl<W: Write> FitsWriter<W>

pub fn new(sink: W) -> Self

pub fn with_checksums(self) -> Self

Enable DATASUM/CHECKSUM integrity keywords on every HDU written through the high-level FitsWriter::write_image / write_table / write_ascii_table methods (§J).

pub fn write_header(&mut self, header: &Header) -> Result<()>

Write a header unit (cards + END + block padding).

pub fn write_data_unit(&mut self, raw: &[u8], fill: u8) -> Result<()>

Write a pre-encoded data unit, padding to a block with fill — NUL for most data, ASCII space for ASCII-table data (§3.1).

pub fn write_image(&mut self, image: &Image) -> Result<()>

Write image as the primary HDU (first call) or an IMAGE extension (later calls). The mandatory header is synthesized (SIMPLE/XTENSION, BITPIX, NAXISn, plus BSCALE/BZERO/BLANK when scaling is non-trivial), followed by the big-endian data unit.

pub fn write_table( &mut self, nrows: usize, columns: &[WriteColumn], ) -> Result<()>

Write a binary table as a BINTABLE extension. A dataless primary HDU is written automatically first if nothing has been written yet (a table can never be the primary HDU). Fixed-width and variable-length (P) columns are both supported — VLA columns write a heap after the main table.

pub fn write_ascii_table( &mut self, nrows: usize, columns: &[AsciiWriteColumn], ) -> Result<()>

Write an ASCII table as a TABLE extension (a dataless primary is written first if needed). Columns are packed left-to-right with no gaps; data is space-padded per §7.2.3.

pub fn write_compressed_image( &mut self, image: &Image, cmptype: &str, options: &CompressOptions, ) -> Result<()>

Available on crate feature compression only.

Write image as a tiled-compressed BINTABLE extension (§10.1), using the ZCMPTYPE codec and the given CompressOptions (tile shape, gzip level, HCOMPRESS scale, float quantization level — each used only by the codecs it applies to). Requires the compression feature. Integer images support GZIP_1/GZIP_2/RICE_1/PLIO_1/HCOMPRESS_1; float images are quantized (SUBTRACTIVE_DITHER_1) and compressed with GZIP_1/GZIP_2/RICE_1. HCOMPRESS_1 needs a 2-D tile shape, and PLIO_1 a non-negative (mask) image.

pub fn write_compressed_table( &mut self, header: &Header, table: &BinTable, rows_per_tile: usize, algo: &str, ) -> Result<()>

Available on crate feature compression only.

Write a fixed-width BINTABLE as a tiled-compressed table (§10.3). header is the original table’s header (column metadata is copied from it), table its parsed data, rows_per_tile the tile height, and algo the per-column codec (GZIP_1/GZIP_2/RICE_1). Requires the compression feature.

pub fn into_inner(self) -> W

Consume the writer and return the underlying sink. HDUs are written eagerly, so an unbuffered sink (e.g. a File) holds the complete file. This does not flush: if the sink is a BufWriter, flush it (or rely on its Drop) before trusting the bytes, and check the flush result if you need write errors surfaced.

Trait Implementations

impl<W: Debug> Debug for FitsWriter<W>

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

Formats the value using the given formatter.