Struct FsFits 

pub struct FsFits { /* private fields */ }

Available on crate feature fs only.

A FITS file read from the filesystem.

Implementations

impl FsFits

pub fn open(path: &Path) -> Result<Self, Box<dyn Error + Send + Sync>>

Opens a new fits file

pub async fn open_async( path: &Path, ) -> Result<Self, Box<dyn Error + Send + Sync>>

Available on crate feature tokio only.

Opens a file asynchronously, this avoids blocking the tokio runtime

pub fn new(path: &Path) -> Self

An empty FITS file that will be written to path.

pub fn save(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Writes this FITS file back to FsFits::path.

The file is written to a temporary file beside it and then renamed, so a failure part way through leaves the original where it was rather than truncated.

pub fn save_as(&self, path: &Path) -> Result<(), Box<dyn Error + Send + Sync>>

Writes this FITS file to path.

pub fn path(&self) -> &Path

Retrieves the path this FITS file belongs to

Trait Implementations

impl Clone for FsFits

fn clone(&self) -> FsFits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FsFits

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

Formats the value using the given formatter.

impl Fits for FsFits

fn to_vec(&self) -> Result<Vec<u8>, Box<dyn Error + Send + Sync>>

Serialises this file, primary HDU first and then every extension.

Each HDU contributes its header followed by its data section, both padded out to whole 2880-byte blocks.

type ImageHDU = FsImageHDU

The kind of image HDU this reader produces.

type BinTableHDU = FsBinTableHDU

The kind of binary table HDU this reader produces.

type AsciiTableHDU = FsAsciiTableHDU

The kind of ASCII table HDU this reader produces.

fn primary_hdu(&self) -> &Self::ImageHDU

The primary HDU, which every FITS file has.

fn primary_hdu_mut(&mut self) -> &mut Self::ImageHDU

The primary HDU, to be changed.

fn extension_count(&self) -> usize

How many extensions follow the primary HDU.

fn extension_hdu(&self, index: usize) -> Option<&ExtensionHDU<Self>>

The extension at index, or None if there is none.

fn extension_hdu_mut(&mut self, index: usize) -> Option<&mut ExtensionHDU<Self>>

The extension at index, to be changed.

fn extension_hdus(&self) -> impl Iterator<Item = &ExtensionHDU<Self>>

Every extension, in the order they appear in the file.

fn extension_hdus_mut( &mut self, ) -> impl Iterator<Item = &mut ExtensionHDU<Self>>

Every extension, to be changed.

fn push_extension(&mut self, extension: ExtensionHDU<Self>)

Appends an extension after the ones already here.

fn remove_extension(&mut self, index: usize) -> Option<ExtensionHDU<Self>>

Removes the extension at index, or returns None if there is none.