settings/display/
types.rs

1// Copyright 2021 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use bitflags::bitflags;
6use serde::{Deserialize, Serialize};
7
8use crate::base::Merge;
9
10#[derive(PartialEq, Debug, Clone, Copy, Serialize, Deserialize)]
11#[serde(deny_unknown_fields)]
12pub struct DisplayInfo {
13    /// The last brightness value that was manually set.
14    pub manual_brightness_value: f32,
15    pub auto_brightness_value: f32,
16    pub auto_brightness: bool,
17    pub screen_enabled: bool,
18    pub low_light_mode: LowLightMode,
19    pub theme: Option<Theme>,
20}
21
22impl DisplayInfo {
23    pub(crate) const fn new(
24        auto_brightness: bool,
25        manual_brightness_value: f32,
26        auto_brightness_value: f32,
27        screen_enabled: bool,
28        low_light_mode: LowLightMode,
29        theme: Option<Theme>,
30    ) -> DisplayInfo {
31        DisplayInfo {
32            manual_brightness_value,
33            auto_brightness_value,
34            auto_brightness,
35            screen_enabled,
36            low_light_mode,
37            theme,
38        }
39    }
40
41    pub(crate) fn is_finite(&self) -> bool {
42        self.manual_brightness_value.is_finite()
43    }
44}
45
46#[derive(Debug, Default, PartialEq, Copy, Clone)]
47pub struct SetDisplayInfo {
48    pub manual_brightness_value: Option<f32>,
49    pub auto_brightness_value: Option<f32>,
50    pub auto_brightness: Option<bool>,
51    pub screen_enabled: Option<bool>,
52    pub low_light_mode: Option<LowLightMode>,
53    pub theme: Option<Theme>,
54}
55
56impl Merge<SetDisplayInfo> for DisplayInfo {
57    fn merge(&self, other: SetDisplayInfo) -> Self {
58        Self {
59            manual_brightness_value: other
60                .manual_brightness_value
61                .unwrap_or(self.manual_brightness_value),
62            auto_brightness_value: other
63                .auto_brightness_value
64                .unwrap_or(self.auto_brightness_value),
65            auto_brightness: other.auto_brightness.unwrap_or(self.auto_brightness),
66            screen_enabled: other.screen_enabled.unwrap_or(self.screen_enabled),
67            low_light_mode: other.low_light_mode.unwrap_or(self.low_light_mode),
68            theme: other.theme.or(self.theme),
69        }
70    }
71}
72
73#[derive(PartialEq, Debug, Clone, Copy, Serialize, Deserialize, Hash, Eq)]
74pub enum LowLightMode {
75    /// Device should not be in low-light mode.
76    Disable,
77    /// Device should not be in low-light mode and should transition
78    /// out of it immediately.
79    DisableImmediately,
80    /// Device should be in low-light mode.
81    Enable,
82}
83
84#[derive(PartialEq, Debug, Clone, Copy, Serialize, Deserialize)]
85pub enum ThemeType {
86    Unknown,
87    Default,
88    Light,
89    Dark,
90}
91
92bitflags! {
93    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
94    pub struct ThemeMode: u32 {
95        /// Product can choose a theme based on ambient cues.
96        const AUTO = 0b00000001;
97    }
98}
99
100bitflags_serde_legacy::impl_traits!(ThemeMode);
101
102#[derive(Debug, Clone, PartialEq, Copy, Serialize, Deserialize)]
103pub struct Theme {
104    pub theme_type: Option<ThemeType>,
105    pub theme_mode: ThemeMode,
106}
107
108impl Theme {
109    pub(super) fn new(theme_type: Option<ThemeType>, theme_mode: ThemeMode) -> Self {
110        Self { theme_type, theme_mode }
111    }
112}
113
114/// Builder for `Theme` that with a `build` method that returns
115/// an `Option` that will be None if all the fields of the Theme would
116/// otherwise be empty.
117pub struct ThemeBuilder {
118    theme_type: Option<ThemeType>,
119    theme_mode: ThemeMode,
120}
121
122impl ThemeBuilder {
123    pub(super) fn new() -> Self {
124        Self { theme_type: None, theme_mode: ThemeMode::empty() }
125    }
126
127    pub(super) fn set_theme_type(&mut self, theme_type: Option<ThemeType>) -> &mut Self {
128        self.theme_type = theme_type;
129        self
130    }
131
132    pub(super) fn set_theme_mode(&mut self, theme_mode: ThemeMode) -> &mut Self {
133        self.theme_mode = theme_mode;
134        self
135    }
136
137    pub(super) fn build(&self) -> Option<Theme> {
138        if self.theme_type.is_none() && self.theme_mode.is_empty() {
139            None
140        } else {
141            Some(Theme { theme_type: self.theme_type, theme_mode: self.theme_mode })
142        }
143    }
144}
settings/display/types.rs

settings/display/
types.rs
