Struct Record 

pub struct Record {
    pub kind: RecordKind,
    /* private fields */
}

One header card. Carries its parsed RecordKind plus, when parsed and unmodified, the original bytes of its physical card(s) so it can be serialized verbatim.

Examples

let r = Record::value("OBJECT", Value::Str("M31".to_string()), Some("target".to_string()));
assert_eq!(r.keyword(), Some("OBJECT"));
assert_eq!(r.str_content(), Some("M31"));
assert_eq!(r.comment(), Some("target"));

Fields

kind: RecordKind

The semantic content.

Implementations

impl Record

pub fn value( keyword: impl Into<String>, value: Value, comment: Option<String>, ) -> Self

A new value card (not byte-backed; formatted on write).

Examples

let r = Record::value("EXPTIME", Value::Literal("120.0".to_string()), None);
assert_eq!(r.keyword(), Some("EXPTIME"));
assert_eq!(r.value_text(), Some("120.0"));

pub fn commentary(keyword: impl Into<String>, text: impl Into<String>) -> Self

A new commentary card (not byte-backed; formatted on write).

Examples

let r = Record::commentary("HISTORY", "dark subtracted");
assert_eq!(r.keyword(), Some("HISTORY"));
assert_eq!(r.value_text(), Some("dark subtracted"));

pub fn keyword(&self) -> Option<&str>

The addressable keyword, or None for opaque cards.

Examples

let mut h = Header::new();
h.set("OBJECT", "M31").unwrap();
assert_eq!(h.cards()[0].keyword(), Some("OBJECT"));

pub fn value_text(&self) -> Option<&str>

The value as text for typed reads: Str content (non-empty), a Literal token, or commentary text. None for empty strings and opaque cards.

Examples

let mut h = Header::new();
h.set("EXPTIME", 120.0).unwrap();
assert_eq!(h.cards()[0].value_text(), Some("120.0"));

pub fn str_content(&self) -> Option<&str>

The Str content of a value card (non-empty), for Header::get_str.

Examples

let mut h = Header::new();
h.set("OBJECT", "M31").unwrap();
h.set("EXPTIME", 120.0).unwrap(); // a Literal, not Str content
assert_eq!(h.cards()[0].str_content(), Some("M31"));
assert_eq!(h.cards()[1].str_content(), None);

pub fn comment(&self) -> Option<&str>

The inline comment of a value card.

Examples

let mut h = Header::new();
h.set("EXPTIME", 120.0).unwrap();
h.set_comment("EXPTIME", "seconds").unwrap();
assert_eq!(h.cards()[0].comment(), Some("seconds"));

Trait Implementations

impl Clone for Record

fn clone(&self) -> Record

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Record

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Record

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Record

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Record

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.