Struct FitsHeaderValueContainer 

pub struct FitsHeaderValueContainer { /* private fields */ }

Available on crate feature fits only.

A representation of the combined header card value and comment. This wrapper ensures that the total number of bytes between the value and comment will not exceed 72.

Implementations

impl FitsHeaderValueContainer

pub fn new<T: FitsHeaderValue + 'static>( value: T, comment: Option<String>, ) -> Result<Self, FitsHeaderError>

Constructs a new FitsHeaderValueContainer with the given value and comment.

pub fn get_value<T: FitsHeaderValue + 'static>( &mut self, ) -> Result<Rc<T>, FitsHeaderError>

Gets the value of the header card. If the value has not yet been deserialized, the deserialization process is attempted. If the process succeeds, the deserialized value is cached.

Examples

use astro_rs::fits::*;

let mut card_value = FitsHeaderValueContainer::from(
    *b"=                    T                                                  ",
);
assert!(card_value.get_value::<Bitpix>().is_err());
assert!(card_value.get_value::<bool>().map(|value| *value).unwrap_or_default());
// value is now cached, deserialization is not attempted, but types differ
assert!(card_value.get_value::<u32>().is_err());
assert!(card_value.get_value::<bool>().map(|value| *value).unwrap_or_default());

pub fn set_value<T: FitsHeaderValue + 'static>( &mut self, value: T, ) -> Result<(), FitsHeaderError>

Sets the value of the header card.

pub fn get_comment(&mut self) -> Result<Rc<String>, FitsHeaderError>

Gets the comment section of the header card.

Examples

use astro_rs::fits::FitsHeaderValueContainer;

let mut card_value = FitsHeaderValueContainer::from(*b"=                    T / FITS STANDARD                                  ");
assert_eq!(*card_value.get_comment()?, String::from("FITS STANDARD"));

pub fn set_comment( &mut self, comment: Option<String>, ) -> Result<(), FitsHeaderError>

Sets the comment section of the header card.

Trait Implementations

impl Clone for FitsHeaderValueContainer

fn clone(&self) -> FitsHeaderValueContainer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FitsHeaderValueContainer

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

Formats the value using the given formatter.

impl From<[u8; 72]> for FitsHeaderValueContainer

fn from(raw: [u8; 72]) -> Self

Converts to this type from the input type.

impl From<FitsHeaderValueContainer> for [u8; 72]

fn from(container: FitsHeaderValueContainer) -> Self

Converts to this type from the input type.