gie-client 0.1.1

Strictly-typed, unofficial Rust client for downloading GIE AGSI and ALSI data.
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

use serde_json::Value;

use crate::error::GieError;

use super::serde_ext::json_vec_to_string;
use super::types::{GieDate, format_date};

#[cfg(feature = "polars")]
use polars::prelude::{Column, NamedFrom, Series};

#[cfg(feature = "polars")]
/// Shared builder for columns present in both AGSI and ALSI dataframe conversions.
#[derive(Debug)]
pub(crate) struct CommonFrameColumns {
    name: Vec<Option<String>>,
    code: Vec<Option<String>>,
    url: Vec<Option<String>>,
    gas_day_start: Vec<Option<String>>,
    info_json: Vec<Option<String>>,
    children_json: Vec<Option<String>>,
}

#[cfg(feature = "polars")]
impl CommonFrameColumns {
    /// Creates an empty column builder with preallocated capacity.
    pub(crate) fn with_capacity(capacity: usize) -> Self {
        Self {
            name: Vec::with_capacity(capacity),
            code: Vec::with_capacity(capacity),
            url: Vec::with_capacity(capacity),
            gas_day_start: Vec::with_capacity(capacity),
            info_json: Vec::with_capacity(capacity),
            children_json: Vec::with_capacity(capacity),
        }
    }

    /// Pushes one logical row into shared columns.
    pub(crate) fn push(
        &mut self,
        name: &Option<String>,
        code: &Option<String>,
        url: &Option<String>,
        gas_day_start: Option<GieDate>,
        info: Option<&[Value]>,
        children: Option<&[Value]>,
    ) -> Result<(), GieError> {
        self.name.push(name.clone());
        self.code.push(code.clone());
        self.url.push(url.clone());
        self.gas_day_start.push(gas_day_start.map(format_date));
        self.info_json.push(json_vec_to_string(info)?);
        self.children_json.push(json_vec_to_string(children)?);
        Ok(())
    }

    /// Returns the number of rows collected so far.
    pub(crate) fn height(&self) -> usize {
        self.name.len()
    }

    /// Returns `(prefix, suffix)` column groups used by endpoint-specific dataframe builders.
    pub(crate) fn into_polars_columns(self) -> (Vec<Column>, Vec<Column>) {
        let prefix = vec![
            Series::new("name".into(), self.name).into(),
            Series::new("code".into(), self.code).into(),
            Series::new("url".into(), self.url).into(),
            Series::new("gas_day_start".into(), self.gas_day_start).into(),
        ];
        let suffix = vec![
            Series::new("info_json".into(), self.info_json).into(),
            Series::new("children_json".into(), self.children_json).into(),
        ];
        (prefix, suffix)
    }
}