openleadr-client 0.1.4

OpenADR 3.0 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use std::sync::Arc;

use openleadr_wire::{report::ReportContent, Report};

use crate::{error::Result, ClientRef};

/// Client to manage the data of a specific report
///
/// Can be created by a [`EventClient`](crate::EventClient)
/// ```no_run
/// # use openleadr_client::{Client, Filter};
/// # use openleadr_wire::event::Priority;
/// let client = Client::with_url("https://your-vtn.com".try_into().unwrap(), None);
/// # tokio_test::block_on(async {
/// let event = client.get_event_by_id(&"event-1".parse().unwrap()).await.unwrap();
///
/// // retrieve all reports in that specific event, optionally filtered by the client name
/// let mut reports = event.get_report_list(Some("client-name")).await.unwrap();
/// let mut report = reports.remove(0);
///
/// // change report name
/// report.content_mut().report_name = Some("new-report-name".to_string());
/// report.update().await.unwrap()
/// # })
/// ```
#[derive(Debug, Clone)]
pub struct ReportClient {
    client: Arc<ClientRef>,
    data: Report,
}

impl ReportClient {
    pub(super) fn from_report(client: Arc<ClientRef>, report: Report) -> Self {
        Self {
            client,
            data: report,
        }
    }

    /// Get the id of the report
    pub fn id(&self) -> &openleadr_wire::report::ReportId {
        &self.data.id
    }

    /// Get the time the report was created on the VTN
    pub fn created_date_time(&self) -> &chrono::DateTime<chrono::Utc> {
        &self.data.created_date_time
    }

    /// Get the time the report was last modified on the VTN
    pub fn modification_date_time(&self) -> &chrono::DateTime<chrono::Utc> {
        &self.data.modification_date_time
    }

    /// Read the data of the report
    pub fn content(&self) -> &ReportContent {
        &self.data.content
    }

    /// Modify the data of the report.
    /// Make sure to call [`update`](Self::update)
    /// after your modifications to store them on the VTN
    pub fn content_mut(&mut self) -> &mut ReportContent {
        &mut self.data.content
    }

    /// Stores any modifications made to the report content at the server
    /// and refreshes the locally stored data with the returned VTN data
    pub async fn update(&mut self) -> Result<()> {
        let res = self
            .client
            .put(&format!("reports/{}", self.id()), &self.data.content)
            .await?;
        self.data = res;
        Ok(())
    }

    /// Delete the report from the VTN
    pub async fn delete(self) -> Result<Report> {
        self.client.delete(&format!("reports/{}", self.id())).await
    }
}