Struct glean_core::metrics::PingType

pub struct PingType {
    pub name: String,
    pub include_client_id: bool,
    pub send_if_empty: bool,
    pub reason_codes: Vec<String>,
}

Stores information about a ping.

This is required so that given metric data queued on disk we can send pings with the correct settings, e.g. whether it has a client_id.

Fields

name: String

The name of the ping.

include_client_id: bool

Whether the ping should include the client ID.

send_if_empty: bool

Whether the ping should be sent if it is empty

reason_codes: Vec<String>

The “reason” codes that this ping can send

Implementations

impl PingType

pub fn new<A: Into<String>>(
    name: A,
    include_client_id: bool,
    send_if_empty: bool,
    reason_codes: Vec<String>
) -> Self

Creates a new ping type for the given name, whether to include the client ID and whether to send this ping empty.

Arguments

• name - The name of the ping.
• include_client_id - Whether to include the client ID in the assembled ping when submitting.
• send_if_empty - Whether the ping should be sent empty or not.
• reason_codes - The valid reason codes for this ping.

pub fn submit(&self, glean: &Glean, reason: Option<&str>) -> bool

Submits the ping for eventual uploading

Arguments

• glean - the Glean instance to use to send the ping.
• reason - the reason the ping was triggered. Included in the ping_info.reason part of the payload.

Returns

See Glean::submit_ping for details.

Trait Implementations

impl Clone for PingType

fn clone(&self) -> PingType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PingType

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

Formats the value using the given formatter.