capybar 0.3.0

Wayland native toolbar
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

//! Current module describes all of capybars included servicees as well as their common behaviour.
//!
//! Process can be treated as a backend component.
//! To communicate with frontend you can use [Signal](crate::util::signals::Signal)

pub mod clients;

use std::{fmt::Display, rc::Rc};

use serde::Deserialize;
use thiserror::Error;

use crate::root::Environment;

fn default_update_rate() -> i64 {
    1000
}

#[derive(Debug, Deserialize, Clone, Copy)]
pub struct ProcessSettings {
    #[serde(default = "default_update_rate")]
    pub update_rate: i64,
}

/// A **data structure** that can be used as a service inside a capybar.
pub trait Service {
    /// Bind a widget to a new environment.
    fn bind(&mut self, env: Rc<Environment>) -> Result<(), ServiceError>;

    /// Prepare [Service] for a first run
    fn init(&self) -> Result<(), ServiceError>;

    /// Run the [Service]
    fn run(&self) -> Result<(), ServiceError>;
}

/// A [Service] that can be unifiedly created.
///
/// Implementing this trait allows creating [Service] and binding the environment without
/// intermidiate steps. Simplifies service creation inside of scripts.
pub trait ServiceNew {
    type Settings;

    fn new(env: Option<Rc<Environment>>, settings: Self::Settings) -> Result<Self, ServiceError>
    where
        Self: Sized;
}

#[derive(Debug, Error)]
pub enum ServiceError {
    /// Argument is a name of a service
    #[error("Trying to run a service \"{0}\" not bound to any environment")]
    RunWithNoEnv(String),

    #[error("Custom error occured in service \"{0}\": \n \"{1}\"")]
    Custom(String, anyhow::Error),
}

/// All available widgets in capybar
#[derive(Debug, Clone)]
pub enum ServiceList {
    Keyboard,
    Custom(String),
}

impl Display for ServiceList {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Keyboard => write!(f, "Keyboard"),
            Self::Custom(name) => write!(f, "{name}"),
        }
    }
}