votable 0.7.0

Rust implementation of a VOTable serializer/deserializer with support for format other than XML, such as JSON, TOML or YAML.
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

//! Module dedicated to the `REPORT` tag.

use std::str::{self, FromStr};

use paste::paste;

use crate::{
  error::VOTableError, mivot::VodmlVisitor, utils::unexpected_attr_err, HasContent, HasContentElem,
  VOTableElement,
};

#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum Status {
  OK,
  FAILED,
}
impl FromStr for Status {
  type Err = String;

  fn from_str(str: &str) -> Result<Self, Self::Err> {
    match str {
      "OK" => Ok(Self::OK),
      "FAILED" => Ok(Self::FAILED),
      _ => Err(format!(
        "Attribute 'status' error in 'REPORT'. Expected: either 'OK' or 'FAILED'. Actual: '{}'.",
        str
      )),
    }
  }
}

impl ToString for Status {
  fn to_string(&self) -> String {
    match self {
      Self::OK => "OK".to_owned(),
      Self::FAILED => "FAILED".to_owned(),
    }
  }
}

/// Structure storing the content of the `REPORT` tag.
/// Tells the client whether the annotation process succeeded or not.
#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct Report {
  /// Status of the annotation process.
  pub status: Status,
  /// Report content.
  #[serde(skip_serializing_if = "Option::is_none")]
  pub content: Option<String>,
}

impl Report {
  pub fn new(status: Status) -> Self {
    Report {
      status,
      content: None,
    }
  }

  impl_builder_mandatory_attr!(status, Status);
  impl_builder_opt_string_attr!(content);

  pub fn visit<V: VodmlVisitor>(&mut self, visitor: &mut V) -> Result<(), V::E> {
    visitor.visit_report(self)
  }
}
impl_has_content!(Report);

impl VOTableElement for Report {
  const TAG: &'static str = "REPORT";

  type MarkerType = HasContentElem;

  fn from_attrs<K, V, I>(attrs: I) -> Result<Self, VOTableError>
  where
    K: AsRef<str> + Into<String>,
    V: AsRef<str> + Into<String>,
    I: Iterator<Item = (K, V)>,
  {
    let mut status: Option<Status> = None;
    // Look for attributes (especially mandatory attributes)
    for (key, val) in attrs {
      let key = key.as_ref();
      match key {
        "status" => status = Some(val.as_ref().parse().map_err(VOTableError::Custom)?),
        _ => return Err(unexpected_attr_err(key, Self::TAG)),
      }
    }
    // Set from found attributes
    if let Some(status) = status {
      Ok(Self::new(status))
    } else {
      Err(VOTableError::Custom(format!(
        "Attributes 'status' is mandatory in tag '{}'",
        Self::TAG
      )))
    }
  }

  fn set_attrs_by_ref<K, V, I>(&mut self, attrs: I) -> Result<(), VOTableError>
  where
    K: AsRef<str> + Into<String>,
    V: AsRef<str> + Into<String>,
    I: Iterator<Item = (K, V)>,
  {
    for (key, val) in attrs {
      let key = key.as_ref();
      match key {
        "status" => self.set_status_by_ref(val.as_ref().parse().map_err(VOTableError::Custom)?),
        _ => return Err(unexpected_attr_err(key, Self::TAG)),
      }
    }
    Ok(())
  }

  fn for_each_attribute<F>(&self, mut f: F)
  where
    F: FnMut(&str, &str),
  {
    f("status", self.status.to_string().as_str());
  }
}