Enum Value 

pub enum Value {
    Integer {
        value: i64,
        comment: Option<String>,
    },
    Float {
        value: f64,
        comment: Option<String>,
    },
    Logical {
        value: bool,
        comment: Option<String>,
    },
    String {
        value: String,
        comment: Option<String>,
    },
    Undefined,
    Invalid(String),
}

The value a header card carries, with the comment written beside it.

FITS gives a card one of four kinds of value — an integer, a floating point number, a logical T/F, or a quoted string — or no value at all. Build one from the Rust type it corresponds to and hand it to Header::set_card:

let mut header = Header::default();
header.set_card("FILTER", "Halpha")?;
header.set_card("GAIN", Value::from(1.5).with_comment("e-/ADU"))?;

Variants

Integer

A whole number, written right-justified against column 30.

Fields

value: i64

The number itself.

comment: Option<String>

The comment after the value, if the card carried one.

Float

A floating point number, written right-justified against column 30.

Fields

value: f64

The number itself.

comment: Option<String>

The comment after the value, if the card carried one.

Logical

A logical, written as the single character T or F.

Fields

value: bool

The truth of it.

comment: Option<String>

The comment after the value, if the card carried one.

String

Text, written in single quotes with any quote inside it doubled.

Fields

value: String

The text, unquoted and with its doubled quotes read back as one.

comment: Option<String>

The comment after the value, if the card carried one.

Undefined

A keyword written with an empty value field, which the standard allows.

Invalid(String)

A value field this crate could not read, kept as the text it held so that nothing is lost.

Implementations

impl Value

pub fn comment_to_string(&self) -> String

The comment beside this value, or an empty string where there is none.

pub fn value_to_string(&self) -> String

This value as the text a card writes it as, without its quotes.

An undefined or unreadable value has no text, and comes back empty.

impl Value

The comment on a value, replaced rather than merged.

pub fn with_comment(self, comment: impl Into<String>) -> Self

This value carrying comment beside it.

A comment on an Value::Undefined or Value::Invalid value has nowhere to live and is dropped: neither of them is written with a value field for a comment to follow.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl From<&String> for Value

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<T: Into<Value>> From<Option<T>> for Value

An absent value is an undefined one: the keyword is written with an empty value field, which is how FITS spells “this card has no value”.

fn from(value: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<usize> for Value

fn from(value: usize) -> Self

Converts to this type from the input type.

impl PartialEq for Value

fn eq(&self, other: &Value) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Value