Struct RemoteSettingsConfig 

pub struct RemoteSettingsConfig {
    pub metrics_enabled: HashMap<String, bool>,
    pub pings_enabled: HashMap<String, bool>,
    pub event_threshold: Option<u32>,
    pub session_sample_rate: Option<f64>,
    pub events_ping_acceleration_factor: Option<usize>,
}

Represents a list of metrics and an associated boolean property indicating if the metric is enabled from the remote-settings configuration store.

The expected format of this data is stringified JSON in the following format:

{
    "category.metric_name": true
}

Fields

metrics_enabled: HashMap<String, bool>

This is a HashMap consisting of base_identifiers as keys and bool values representing an override for the disabled property of the metric, only inverted to reduce confusion. If a particular metric has a value of true here, it means the default of the metric will be overriden and set to the enabled state.

pings_enabled: HashMap<String, bool>

This is a HashMap consisting of ping names as keys and boolean values representing on override for the default enabled state of the ping of the same name.

event_threshold: Option<u32>

The threshold of events that will be buffered before an events ping is collected and submitted. It overrides the value configured at initialization time.

session_sample_rate: Option<f64>

Remote override for the session sampling rate (0.0–1.0). When set, this overrides the value configured at initialization time. Changes take effect at the next session start.

events_ping_acceleration_factor: Option<usize>

The number of “events” pings to accelerate each session, plus one. It overrides the value configured at initialization time.

Implementations

impl RemoteSettingsConfig

pub fn new() -> Self

Creates a new RemoteSettingsConfig

Trait Implementations

impl Clone for RemoteSettingsConfig

fn clone(&self) -> RemoteSettingsConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RemoteSettingsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RemoteSettingsConfig

fn default() -> RemoteSettingsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RemoteSettingsConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MallocSizeOf for RemoteSettingsConfig

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl Serialize for RemoteSettingsConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for RemoteSettingsConfig

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(json: String) -> Result<Self, Self::Error>

Performs the conversion.