factom 2.1.1

Factom API client
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

//! Response handling functions to parse json responses into objects
use super::*;
use std::default::Default;
use std::error::Error;
use std::fmt::{self, Debug, Display};

/// JSON responses are deserialized into this struct
#[derive(Deserialize, Debug, PartialEq, Default)]
pub struct ApiResponse<T>
  where T: Default
{
  pub jsonrpc: String,
  pub id: u32,
  #[serde(default)]
  pub result: T,
  #[serde(default)]
  pub error: ApiError
}

/// Generic Factom API Error struct
#[derive(Deserialize, PartialEq, Default, Debug)]
pub struct ApiError {
  pub code: i16,
  pub message: String
}

impl<T> Display for  ApiResponse<T> 
  where T: Default + Debug + Display
{
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
      write!(f, "id: {}\nresult: {}\n error: {}", 
                self.id, self.result, self.error)
  }
}

impl Display for  ApiError {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
      write!(f, "{}", self)
  }
}

impl<T> Error for ApiResponse<T> 
  where T: Default + Debug + Display
{
  fn description(&self) -> &str {
    &self.error.message
  }
}

impl<T> ApiResponse<T>
  where T: Default
{
  /// Returns a boolean representing whether the api response returned an error
  /// This function does not deal with network errors, that is handled earlier
  /// by the Result from running the future query to completion.
  pub fn is_err(&self) -> bool {
    self.error.code != 0i16
  }
  /// Returns a boolean representing whether the api response returned an error
  /// This function does not deal with network errors, that is handled earlier
  /// by the Result from running the future query to completion.
  pub fn success(&self) -> bool {
    self.error.code == 0i16
  }
}