gear-common 1.0.2-gtest-dev

Gear common library for the runtime
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

// This file is part of Gear.

// Copyright (C) 2022-2023 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Module for toggler/flag implementation.
//!
//! Toggler provides API for allowing or denying actions.
//! Could be used to branch logic by toggler condition.

use crate::storage::ValueStorage;
use core::marker::PhantomData;

/// Represents logic of providing access for some actions.
pub trait Toggler {
    /// Sets condition to allowed for some action.
    fn allow();

    /// Returns bool, defining does toggle allow some action.
    fn allowed() -> bool;

    /// Returns bool, defining does toggle deny some action.
    ///
    /// Represents `Self::allowed` inversion.
    fn denied() -> bool {
        !Self::allowed()
    }

    /// Sets condition to denied for some action.
    fn deny();
}

/// `Toggler` implementation based on `ValueStorage`.
pub struct TogglerImpl<VS: ValueStorage>(PhantomData<VS>);

// `Toggler` implementation over `ValueStorage` of `bool` storing type.
impl<VS: ValueStorage<Value = bool>> Toggler for TogglerImpl<VS> {
    fn allow() {
        VS::put(true);
    }

    fn allowed() -> bool {
        VS::get() != Some(false)
    }

    fn deny() {
        VS::put(false);
    }
}