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;
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 {
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 currently stored value as a boolean.
22    ///
23    /// This doesn't clear the stored value.
24    ///
25    /// # Arguments
26    ///
27    /// * `ping_name` - represents the optional name of the ping to retrieve the
28    ///   metric for. Defaults to the first value in `send_in_pings`.
29    fn test_get_value<'a, S: Into<Option<&'a str>>>(&self, ping_name: S) -> Option<bool>;
30
31    /// **Exported for test purposes.**
32    ///
33    /// Gets the number of recorded errors for the given metric and error type.
34    ///
35    /// # Arguments
36    ///
37    /// * `error` - The type of error
38    ///
39    /// # Returns
40    ///
41    /// The number of errors reported.
42    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
43}
glean_core/traits/boolean.rs

glean_core/traits/
boolean.rs
