TOAInfo

Struct TOAInfo 

Source
pub struct TOAInfo {
    pub is_bad: bool,
    pub file: String,
    pub frequency: f64,
    pub mjd: Mjd,
    pub mjd_error: f64,
    pub site_id: String,
    pub comment: String,
    pub flags: HashMap<String, Flag>,
}
Expand description

The basic information contained in a calculated TOA.

Fields§

§is_bad: bool

Whether the TOA is marked as bad.

§file: String

The original file the TOA came from.

§frequency: f64

Observation frequency.

§mjd: Mjd

The date-time.

§mjd_error: f64

The error in MJD.

§site_id: String

The observation site identifier.

§comment: String

Any comments left in the line.

§flags: HashMap<String, Flag>

All flags found. Which flags are used depends on the file’s creator, but they are all put as either of two versions: f64 and String.

Implementations§

Source§

impl TOAInfo

Source

pub fn from_line_tempo2(line: &str) -> Result<Self, PsruError>

Parses a single line of .tim-file information in TEMPO2-style.

§Errors

Returns errors for any malformed parameters.

let line = "fname 1.0 55.0 0.0 st -flag value -flag2 42";
let info = TOAInfo::from_line_tempo2(line).unwrap();
let toa = TOAInfo {
    is_bad: false,
    file: String::from("fname"),
    frequency: 1.0,
    mjd: Mjd::new(55, 0.0),
    mjd_error: 0.0,
    site_id: String::from("st"),
    flags: HashMap::from([
        (String::from("flag"), Flag::String(String::from("value"))),
        (String::from("flag2"), Flag::Double(42.0)),
    ]),
    comment: String::new(),
};
assert_eq!(info, toa);

Trait Implementations§

Source§

impl Debug for TOAInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TOAInfo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TOAInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.