reduct-base 1.21.0

Base crate for ReductStore
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

// Copyright 2021-2026 ReductSoftware UG
// Licensed under the Apache License, Version 2.0

use crate::msg::bucket_api::{BucketInfo, BucketSettings};
use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use std::fmt::{Display, Formatter};

/// License information
///
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
pub struct License {
    /// Licensee usually is the company name
    pub licensee: String,
    /// Invoice number
    pub invoice: String,
    /// Expiry date
    pub expiry_date: DateTime<Utc>,
    /// Plan name
    pub plan: String,
    /// Number of devices (0 for unlimited)
    pub device_number: u32,
    /// Disk quota in TB (0 for unlimited)
    pub disk_quota: i32,
    /// Fingerprint
    #[serde(default)]
    pub fingerprint: String,
}

impl Display for License {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "\n\tLicensee: {}\n\tInvoice: {}\n\tExpiry Date: {}\n\tPlan: {}\n\tNumber of Devices: {}\n\tDisk Quota: {} TB,\n\tFingerprint: {}",
            self.licensee, self.invoice, self.expiry_date, self.plan, self.device_number, self.disk_quota, self.fingerprint
        )
    }
}

/// Information about a ReductSoftware UG instance
#[derive(Serialize, Deserialize, Default, Clone, Debug, PartialEq)]
pub struct ServerInfo {
    /// Version of ReductSoftware UG instance
    pub version: String,
    /// Effective instance name resolved from the runtime configuration
    #[serde(default)]
    pub instance_name: String,
    /// Effective instance role (`STANDALONE`, `PRIMARY`, `SECONDARY`, or `REPLICA`)
    #[serde(default)]
    pub instance_role: String,
    /// Number of buckets
    pub bucket_count: u64,
    /// Disk usage in bytes
    pub usage: u64,
    /// Uptime in seconds
    pub uptime: u64,
    /// Oldest record in instance
    pub oldest_record: u64,
    /// Latest record in instance
    pub latest_record: u64,
    /// Default settings
    pub defaults: Defaults,
    /// License information if it is `None`, then the instance uses Apache-2.0
    pub license: Option<License>,
}

/// Default settings
#[derive(Serialize, Deserialize, Default, Clone, Debug, PartialEq)]
pub struct Defaults {
    pub bucket: BucketSettings,
}

/// BucketLists
#[derive(Serialize, Deserialize, Default, Clone, Debug, PartialEq)]
pub struct BucketInfoList {
    pub buckets: Vec<BucketInfo>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn server_info_deserializes_without_instance_identity() {
        let mut value = serde_json::to_value(ServerInfo {
            instance_name: "edge-a".to_string(),
            instance_role: "PRIMARY".to_string(),
            ..ServerInfo::default()
        })
        .unwrap();
        let object = value.as_object_mut().unwrap();
        object.remove("instance_name");
        object.remove("instance_role");

        let info: ServerInfo = serde_json::from_value(value).unwrap();
        assert_eq!(info.instance_name, "");
        assert_eq!(info.instance_role, "");
    }
}