Struct rubbl_fits::FitsDecoder

pub struct FitsDecoder<R: Read> { /* private fields */ }

A decoder for single-pass streaming of a FITS file.

This struct decodes its input stream assuming it is in FITS format. The decoding is extremely low-level; only enough work is done to separate the stream into headers and data correctly. The underlying stream need only implement Read, and the items that are streamed out are well-suited for reproducing the input file byte-for-byte.

This class is not very picking about checking FITS conformity.

Implementations

impl<R: Read> FitsDecoder<R>

Note that we can’t implement our I/O paradigm using Iterator because Rust’s iterators aren’t “streaming”: basically, the Rust paradigm is that you can look at multiple iterator items at once, which isn’t compatible with our desire to be zero-copy and return byte slices rather than allocate vecs. See this discussion.

pub fn new(inner: R) -> Self

Create a new decoder that gets data from the Read type passed as an argument.

pub fn next<'a>(&'a mut self) -> Result<Option<LowLevelFitsItem<'a>>, FitsError>

Get the next item in the FITS stream.

Returns Ok(None) at an expected EOF.

pub fn into_inner(self) -> R

Consume this decoder and return the inner Read object.

Trait Implementations

impl<R: Clone + Read> Clone for FitsDecoder<R>

fn clone(&self) -> FitsDecoder<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.