confish 0.1.0

Official Rust SDK for confish — typed configuration, actions, and webhooks.
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

#![allow(missing_docs)] // enum variants and struct fields document themselves

use serde::{Deserialize, Serialize};

/// Log severity levels accepted by the logging API.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum LogLevel {
    Debug,
    Info,
    Notice,
    Warning,
    Error,
    Critical,
    Alert,
}

/// An action's lifecycle status.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ActionStatus {
    Pending,
    Acknowledged,
    Completed,
    Failed,
    Expired,
}

/// A single timeline entry on an [`Action`].
#[derive(Debug, Clone, Deserialize)]
pub struct ActionUpdate {
    pub message: String,
    #[serde(default)]
    pub data: Option<serde_json::Value>,
    #[serde(default)]
    pub timestamp: Option<String>,
}

/// An action returned by the actions API.
///
/// `params` and `result` stay as `serde_json::Value` so callers can decode them into
/// their own types via [`serde_json::from_value`].
#[derive(Debug, Clone, Deserialize)]
pub struct Action {
    pub id: String,
    #[serde(rename = "type")]
    pub kind: String,
    pub status: ActionStatus,
    #[serde(default)]
    pub params: Option<serde_json::Value>,
    #[serde(default)]
    pub updates: Vec<ActionUpdate>,
    #[serde(default)]
    pub result: Option<serde_json::Value>,
    #[serde(default)]
    pub expires_at: Option<String>,
    #[serde(default)]
    pub acknowledged_at: Option<String>,
    #[serde(default)]
    pub completed_at: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
}