mairie360_api_lib 0.3.4

Lib for mairie360 APIs
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

use serde_json;
use std::fmt;

/**
 * This module provides utility functions to handle query results in a database context.
 * It defines a `QueryResult` enum to encapsulate different types of results,
 */
#[derive(Debug, PartialEq)]
pub enum QueryResult {
    Boolean(bool),
    JSON(serde_json::Value),
    Result(Result<(), String>),
    U64(u64),
}

/**
 * This function takes a `QueryResult` and returns a boolean value.
 * If the result is of type `QueryResult::Boolean`, it returns the boolean value.
 * If the result is not of type `QueryResult::Boolean`, it prints an error message and returns `false`.
 * * # Arguments
 * * `result`: A `QueryResult` enum instance.
 * # Returns
 * * A boolean value extracted from the `QueryResult`.
 */
pub fn get_boolean_from_query_result(result: QueryResult) -> bool {
    match result {
        QueryResult::Boolean(b) => b,
        _ => {
            eprintln!("Expected QueryResult::Boolean");
            false
        }
    }
}

/**
 * This function takes a `QueryResult` and returns a `serde_json::Value`.
 * If the result is of type `QueryResult::JSON`, it returns the contained JSON value
 *
 * # Arguments
 * `result`: A `QueryResult` enum instance.
 *
 * # Returns
 * A `serde_json::Value` extracted from the `QueryResult`.
 */
pub fn get_json_from_query_result(result: QueryResult) -> serde_json::Value {
    match result {
        QueryResult::JSON(json) => json,
        _ => {
            eprintln!("Expected QueryResult::JSON");
            serde_json::Value::Null
        }
    }
}

/**
 * This function takes a `QueryResult` and returns a `Result<(), String>`.
 * If the result is of type `QueryResult::Result`, it returns the contained result.
 * If the result is not of type `QueryResult::Result`, it prints an error message and returns an error.
 * * # Arguments
 * * `result`: A `QueryResult` enum instance.
 * # Returns
 * * A `Result<(), String>` extracted from the `QueryResult`.
 */
pub fn get_result_from_query_result(result: QueryResult) -> Result<(), String> {
    match result {
        QueryResult::Result(res) => res,
        _ => {
            eprintln!("Expected QueryResult::Result");
            Err("Expected QueryResult::Result".to_string())
        }
    }
}

/**
 * This function takes a `QueryResult` and returns a `u64`.
 * If the result is of type `QueryResult::U64`, it returns the contained value.
 * If the result is not of type `QueryResult::U64`, it prints an error message and returns 0.
 * * # Arguments
 * * `result`: A `QueryResult` enum instance.
 * # Returns
 * * A `u64` extracted from the `QueryResult`.
 */
pub fn get_u64_from_query_result(result: QueryResult) -> u64 {
    match result {
        QueryResult::U64(i) => i,
        _ => {
            eprintln!("Expected QueryResult::U64");
            0
        }
    }
}

impl fmt::Display for QueryResult {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            QueryResult::Boolean(b) => write!(f, "{}", b),
            QueryResult::JSON(json) => write!(f, "{}", json),
            QueryResult::Result(res) => match res {
                Ok(_) => write!(f, "Success"),
                Err(e) => write!(f, "Error: {}", e),
            },
            QueryResult::U64(i) => write!(f, "{}", i),
        }
    }
}