hyprshell-config-lib 4.10.2

A library for reading, writing and migrating configuration files for hyprshell
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

use crate::Modifier;
use std::path::Path;

#[derive(Debug, Clone, PartialEq)]
pub struct Config {
    pub windows: Option<Windows>,
}

impl Default for Config {
    fn default() -> Self {
        crate::io::Config::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct Windows {
    pub general: WindowsGeneral,
    pub overview: Option<Overview>,
    pub switch: Option<Switch>,
    pub switch_2: Option<Switch>,
}

impl Default for Windows {
    fn default() -> Self {
        crate::io::Windows::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct WindowsGeneral {
    pub scale: f64,
    pub items_per_row: u8,
}

#[derive(Debug, Clone, PartialEq)]
pub struct Overview {
    pub launcher: Launcher,
    pub key: Box<str>,
    pub top_offset: u16,
    pub modifier: Modifier,
    pub filter_by_same_class: bool,
    pub filter_by_current_workspace: bool,
    pub filter_by_current_monitor: bool,
    pub exclude_workspaces: Box<str>,
}

impl Default for Overview {
    fn default() -> Self {
        crate::io::Overview::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct Launcher {
    pub default_terminal: Option<Box<str>>,
    pub launch_modifier: Modifier,
    pub width: u16,
    pub max_items: u8,
    pub show_when_empty: bool,
    pub plugins: Plugins,
}

impl Default for Launcher {
    fn default() -> Self {
        crate::io::Launcher::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct Plugins {
    pub applications: Option<ApplicationsPluginConfig>,
    pub terminal: Option<()>,
    pub shell: Option<()>,
    pub websearch: Option<WebSearchConfig>,
    pub calc: Option<()>,
    pub path: Option<()>,
    pub actions: Option<ActionsPluginConfig>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct ActionsPluginConfig {
    pub actions: Vec<ActionsPluginAction>,
}

impl Default for ActionsPluginConfig {
    fn default() -> Self {
        crate::io::ActionsPluginConfig::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ApplicationsPluginConfig {
    pub run_cache_weeks: u8,
    pub show_execs: bool,
    pub show_actions_submenu: bool,
}

impl Default for ApplicationsPluginConfig {
    fn default() -> Self {
        crate::io::ApplicationsPluginConfig::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum ActionsPluginAction {
    LockScreen,
    Hibernate,
    Logout,
    Reboot,
    Shutdown,
    Suspend,
    Custom(ActionsPluginActionCustom),
}

#[derive(Debug, Clone, Eq, PartialEq)]
pub struct ActionsPluginActionCustom {
    pub names: Vec<Box<str>>,
    pub details: Box<str>,
    pub command: Box<str>,
    pub icon: Box<Path>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct WebSearchConfig {
    pub engines: Vec<SearchEngine>,
}

impl Default for WebSearchConfig {
    fn default() -> Self {
        crate::io::WebSearchConfig::default()
            .try_into()
            .expect("the default config invalid")
    }
}

#[derive(Debug, Clone, Eq, PartialEq)]
pub struct SearchEngine {
    pub url: Box<str>,
    pub name: Box<str>,
    pub key: char,
}

#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Switch {
    pub modifier: Modifier,
    pub key: Box<str>,
    pub filter_by_same_class: bool,
    pub filter_by_current_workspace: bool,
    pub filter_by_current_monitor: bool,
    pub switch_workspaces: bool,
    pub exclude_workspaces: Box<str>,
    pub kill_key: char,
}

impl Default for Switch {
    fn default() -> Self {
        crate::io::Switch::default()
            .try_into()
            .expect("the default config invalid")
    }
}