Struct FitsKeyword 

pub struct FitsKeyword {
    pub name: String,
    pub comment: String,
    /* private fields */
}

A single FITS keyword extracted from (or destined for) an XISF header: a name, a value, and an optional comment.

The value’s on-disk kind (quoted string vs. bare literal) is preserved; see IntoValue for how the kind is chosen when you write one.

use xisf_header::FitsKeyword;

let kw = FitsKeyword::new("IMAGETYP", "Master Dark", "Type of image");
assert_eq!(kw.value_str(), "Master Dark");
assert_eq!(kw.comment, "Type of image");

Fields

name: String

The keyword name (e.g. EXPTIME), kept verbatim.

comment: String

The keyword comment (empty when absent).

Implementations

impl FitsKeyword

pub fn new( name: impl Into<String>, value: impl IntoValue, comment: impl Into<String>, ) -> Self

Create a keyword from its name, value, and comment.

use xisf_header::FitsKeyword;
let kw = FitsKeyword::new("GAIN", 100_i64, "Sensor gain");
assert_eq!(kw.get::<i64>(), Some(100));

pub fn value_str(&self) -> &str

The value’s raw text, regardless of kind.

use xisf_header::FitsKeyword;

let kw = FitsKeyword::new("OBJECT", "NGC 7000", "Target");
assert_eq!(kw.value_str(), "NGC 7000");

pub fn get<T: FromField>(&self) -> Option<T>

Interpret the value as T (see FromField).

use xisf_header::FitsKeyword;

let kw = FitsKeyword::new("EXPTIME", 300.0, "");
assert_eq!(kw.get::<f64>(), Some(300.0));

Trait Implementations

impl Clone for FitsKeyword

fn clone(&self) -> FitsKeyword

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FitsKeyword

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

Formats the value using the given formatter.

impl Default for FitsKeyword

fn default() -> FitsKeyword

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FitsKeyword

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FitsKeyword

impl PartialEq for FitsKeyword

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FitsKeyword

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FitsKeyword