glean_core/traits/
boolean.rs

1// This Source Code Form is subject to the terms of the Mozilla Public
2// License, v. 2.0. If a copy of the MPL was not distributed with this
3// file, You can obtain one at https://mozilla.org/MPL/2.0/.
4
5use crate::{ErrorType, TestGetValue};
6
7/// A description for the [`BooleanMetric`](crate::metrics::BooleanMetric) type.
8///
9/// When changing this trait, make sure all the operations are
10/// implemented in the related type in `../metrics/`.
11pub trait Boolean: TestGetValue<bool> {
12    /// Sets to the specified boolean value.
13    ///
14    /// # Arguments
15    ///
16    /// * `value` - the value to set.
17    fn set(&self, value: bool);
18
19    /// **Exported for test purposes.**
20    ///
21    /// Gets the number of recorded errors for the given metric and error type.
22    ///
23    /// # Arguments
24    ///
25    /// * `error` - The type of error
26    ///
27    /// # Returns
28    ///
29    /// The number of errors reported.
30    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
31}