lb-rs 26.4.13

The rust library for interacting with your lockbook.
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

use crate::Lb;
use crate::model::api::{FileUsage, GetUsageRequest};
use crate::model::errors::LbResult;
use crate::model::usage::get_usage;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct UsageMetrics {
    pub usages: Vec<FileUsage>,
    pub server_usage: UsageItemMetric,
    pub data_cap: UsageItemMetric,
}

#[derive(Serialize, Deserialize, PartialEq, Eq, Debug, Clone)]
pub struct UsageItemMetric {
    pub exact: u64,
    pub readable: String,
}

impl Lb {
    /// fetches data footprint on server along with data cap information
    /// compares this to local changes to estimate net data increase
    ///
    /// callers of this function should be prepared to handle:
    /// - [crate::LbErrKind::AccountNonexistent]
    /// - [crate::LbErrKind::ClientUpdateRequired]
    /// - [crate::LbErrKind::ServerUnreachable]
    #[instrument(level = "debug", skip(self))]
    pub async fn get_usage(&self) -> LbResult<UsageMetrics> {
        let acc = self.get_account()?;
        let usage = self.client.request(acc, GetUsageRequest {}).await?;
        Ok(get_usage(usage))
    }
}