boomack 0.4.1

Client library for Boomack
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

//! Structures and functions to create
//! [`ClientRequest`](../api/struct.ClientRequest.html) instances
//! for managing panels

use serde::Serialize;
use super::json::{JsonMap, to_json_map};
use super::api::ClientRequest;

pub fn get_panel_ids_request() -> ClientRequest {
    ClientRequest::get(format!("panels"))
}

pub fn get_panel_layout_request(panel_id: Option<&str>) -> ClientRequest {
    ClientRequest::get(format!("panels/{}/layout",
        panel_id.unwrap_or("default")))
}

pub fn set_panel_layout_request(panel_id: &str, layout: JsonMap) -> ClientRequest {
    let mut req = ClientRequest::put(format!("panels/{}/layout", panel_id));
    req.set_json_body(layout);
    req
}

pub fn delete_panel_request(panel_id: &str) -> ClientRequest {
    ClientRequest::delete(format!("panels/{}", panel_id))
}

pub fn clear_panel_request(panel_id: Option<&str>) -> ClientRequest {
    ClientRequest::post(format!("panels/{}/clear",
        panel_id.unwrap_or("default")))
}

/// Parameters for exporting an individual panel
/// as HTML file to the filesystem of the Boomack Server.
#[derive(Serialize)]
pub struct PanelExportParameters<'l> {
    /// A relative path to the target folder of the export.
    /// The path is always relative to the root export folder,
    /// configured in the Boomack Server.
    pub path: Option<&'l str>,
    /// The target filename without extensions
    pub name: Option<&'l str>,
    /// The theme to use during export
    pub theme: Option<&'l str>,
    /// A static CSS zoom factor for the export (1.0 = 100%)
    pub zoom: Option<f32>,
    // Controls visibility of the logo from the panel header during export.
    pub logo: Option<bool>,
    // Control visibility of the panel header during export.
    pub header: Option<bool>,
    // Controls visibility of tools in slot toolbars during export.
    pub tools: Option<bool>,
    // Control visibility of slot toolbars during export.
    pub toolbars: Option<bool>,
}

pub fn export_panel_request(panel_id: Option<&str>, p: PanelExportParameters) -> ClientRequest {
    let mut req = ClientRequest::post(format!("panels/{}/export",
        panel_id.unwrap_or("default")));
    req.set_json_body(to_json_map(&p).unwrap());
    req
}

/// Parameters for exporting all panels
/// as HTML files to the filesystem of the Boomack Server.
#[derive(Serialize)]
pub struct AllPanelExportParameters<'l> {
    /// A relative path to the target folder of the export.
    /// The path is always relative to the root export folder,
    /// configured in the Boomack Server.
    pub path: Option<&'l str>,
    // The theme to use during export
    pub theme: Option<&'l str>,
    // A static CSS zoom factor for the export (1.0 = 100%)
    pub zoom: Option<f32>,
    // Controls visibility of the logo from the panel header during export.
    pub logo: Option<bool>,
    // Control visibility of the panel header during export.
    pub header: Option<bool>,
    // Controls visibility of tools in slot toolbars during export.
    pub tools: Option<bool>,
    // Control visibility of slot toolbars during export.
    pub toolbars: Option<bool>,
}

pub fn export_all_panels_request(p: AllPanelExportParameters)
    -> ClientRequest
{
    let mut req = ClientRequest::post(format!("panels/export"));
    req.set_json_body(to_json_map(&p).unwrap());
    req
}