satkit 0.18.0

Satellite Toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

//! Errors produced by the `omm` module.

use std::num::{ParseFloatError, ParseIntError};

use thiserror::Error;

/// Errors that can occur while parsing or using OMM messages.
#[derive(Debug, Error)]
pub enum Error {
    #[error("Missing required field {0}")]
    MissingField(&'static str),

    #[error("Invalid float for {field}: {source}")]
    InvalidFloatField {
        field: &'static str,
        #[source]
        source: ParseFloatError,
    },

    #[error("Invalid float value: {0}")]
    InvalidFloat(#[from] ParseFloatError),

    #[error("Invalid integer value: {0}")]
    InvalidInt(#[from] ParseIntError),

    /// Raised when [`OMM::epoch_instant`](crate::omm::OMM::epoch_instant)
    /// fails to parse `epoch` as RFC 3339.
    #[error(transparent)]
    InvalidEpoch(#[from] crate::time::InstantError),

    #[error("Unsupported MEAN_ELEMENT_THEORY: {0}")]
    UnsupportedMeanElementTheory(String),

    #[error("Unsupported TIME_SYSTEM for SGP4: {0}")]
    UnsupportedTimeSystem(String),

    #[error(transparent)]
    Json(#[from] serde_json::Error),

    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[cfg(feature = "download")]
    #[error(transparent)]
    Http(#[from] ureq::Error),

    /// Returned by [`OMM::from_url`](crate::omm::OMM::from_url) when the
    /// response looks like XML but the `omm-xml` cargo feature is disabled.
    #[error("Response appears to be XML but the `omm-xml` feature is not enabled")]
    XmlFeatureDisabled,

    #[cfg(feature = "omm-xml")]
    #[error(transparent)]
    Xml(#[from] quick_xml::DeError),
}

/// Convenient type alias used throughout the `omm` module.
pub type Result<T> = std::result::Result<T, Error>;