busylib 0.0.9

BUSY Bar Rust HTTP 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

//! Settings schemas

use serde::{Deserialize, Serialize};

use crate::types::access_key::AccessKey;
use crate::types::brightness::Brightness;
use crate::types::device_name::DeviceName;
use crate::types::volume::Volume;

/// How the HTTP API can be reached over Wi-Fi
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum HttpAccess {
    Disabled,
    Enabled,
    Key(AccessKey),
}

impl HttpAccess {
    pub fn mode(&self) -> AccessMode {
        match self {
            HttpAccess::Disabled => AccessMode::Disabled,
            HttpAccess::Enabled => AccessMode::Enabled,
            HttpAccess::Key(_) => AccessMode::Key,
        }
    }

    pub fn key(&self) -> Option<&AccessKey> {
        match self {
            HttpAccess::Key(key) => Some(key),
            _ => None,
        }
    }
}

/// Access modes of the HTTP API
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum AccessMode {
    Disabled,
    Enabled,
    Key,
}

impl AccessMode {
    pub fn as_str(self) -> &'static str {
        match self {
            AccessMode::Disabled => "disabled",
            AccessMode::Enabled => "enabled",
            AccessMode::Key => "key",
        }
    }
}

/// Reported HTTP API access configuration
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct HttpAccessInfo {
    /// Access mode
    pub mode: AccessMode,
    /// Access key was set and is valid
    pub key_valid: Option<bool>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub(crate) struct NameInfo {
    /// Device name (letters, digits, spaces and common punctuation; no backtick or tilde)
    pub name: DeviceName,
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub(crate) struct AudioVolumeInfo {
    /// Audio volume value (0-100)
    pub volume: Volume,
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
pub(crate) struct DisplayBrightnessInfo {
    /// Displays brightness (0-100/auto)
    pub value: Brightness,
}