fsipc 0.12.0

fsipc, zbus Proxy for the modio-logger DBus interface
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

// Author: D.S. Ljungmark <spider@skuggor.se>, Modio AB
// SPDX-License-Identifier: MIT
//! # `DBus` interface proxies for: `se.modio.logger`, `se.modio.logger.Logger1`, `se.modio.logger.fsipc`
//!
//! This code was generated by `zbus-xmlgen` `3.0.0` from `DBus` introspection data.
//! Source: `Interface '/se/modio/logger' from service 'se.modio.logger' on session bus`.
//!
//! You may prefer to adapt it, instead of using it verbatim.
//!
//! More information can be found in the
//! [Writing a client proxy](https://dbus.pages.freedesktop.org/zbus/client.html)
//! section of the zbus documentation.
//!
//! This `DBus` object implements
//! [standard `DBus` interfaces](https://dbus.freedesktop.org/doc/dbus-specification.html),
//! (`org.freedesktop.DBus.*`) for which the following zbus proxies can be used:
//!
//! * [`zbus::fdo::PropertiesProxy`]
//! * [`zbus::fdo::PeerProxy`]
//! * [`zbus::fdo::IntrospectableProxy`]
//!
//! …consequently `zbus-xmlgen` did not generate code for the above interfaces.

use serde::Deserialize;
use serde::Serialize;
use std::collections::HashMap;
use zbus::proxy;
use zbus::zvariant::{DeserializeDict, SerializeDict, Type, Value};

pub type ValueMap = HashMap<u32, String>;

#[derive(Debug, PartialEq, Eq, Type, Serialize, Deserialize)]
pub enum SensorMode {
    ReadOnly,
    ReadWrite,
    WriteOnly,
}

#[derive(Debug, Copy, Clone, PartialEq, Eq, Type, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum DataType {
    F64,
    String,
    Bool,
    U64,
}

// This type should match the one here:
// https://gitlab.com/ModioAB/modio-logger/-/blob/main/modio-logger/src/types.rs
#[derive(Debug, PartialEq, Eq, DeserializeDict, SerializeDict, Type)]
#[zvariant(signature = "dict")]
pub struct Metadata {
    pub n: String,
    pub u: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub value_map: Option<ValueMap>,
    pub mode: Option<SensorMode>,
    pub value_type: Option<DataType>,
}

#[proxy(
    interface = "se.modio.logger.Logger1",
    default_service = "se.modio.logger",
    default_path = "/se/modio/logger"
)]
pub trait Logger1 {
    /// GetMetadata method
    fn get_metadata(&self, key: &str) -> zbus::Result<Metadata>;

    /// SetMetadataDescription method
    fn set_metadata_description(&self, key: &str, description: &str) -> zbus::Result<()>;

    /// SetMetadataMode method
    fn set_metadata_mode(&self, key: &str, mode: SensorMode) -> zbus::Result<()>;

    /// SetMetadataName method
    fn set_metadata_name(&self, key: &str, name: &str) -> zbus::Result<()>;

    /// SetMetadataUnit method
    fn set_metadata_unit(&self, key: &str, unit: &str) -> zbus::Result<()>;

    /// SetMetadataValueMap method
    fn set_metadata_value_map(&self, key: &str, value_map: ValueMap) -> zbus::Result<()>;

    /// SetMetadataValueType method
    fn set_metadata_value_type(&self, key: &str, value_type: DataType) -> zbus::Result<()>;

    /// MetadataUpdated signal
    #[zbus(signal)]
    fn metadata_updated(&self, key: &str) -> zbus::Result<()>;

    /// StoreBatch method,  store a batch of key:value for Anachronistic Measures
    async fn store_batch(&self, batch: HashMap<String, Value<'_>>) -> zbus::Result<()>;

    /// Store method,  store a single key:value of an Anachronistic Measure
    /// ( Wraps store_batch internally, only use for ease of porting)
    async fn store(&self, key: String, value: Value<'_>) -> zbus::Result<()>;

    fn store_ts(&self, batch: Vec<(String, Value<'_>, f64)>) -> zbus::Result<()>;

    fn store_rows(&self, rows: Vec<(f64, Vec<Value<'_>>)>) -> zbus::Result<()>;

    /// Signal sent when values are stored.
    /// Contents is a vector of (key, value, timestamp)
    #[zbus(signal)]
    async fn store_signal(&self, batch: Vec<(String, Value<'_>, i64)>) -> zbus::Result<()>;
}