Struct glean::private::PingType

pub struct PingType { /* fields omitted */ }

A ping is a bundle of related metrics, gathered in a payload to be transmitted.

The ping payload will be encoded in JSON format and contains shared information data.

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.

Arguments

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

pub fn test_before_next_submit(
    &self,
    cb: impl FnOnce(Option<&str>) + Send + 'static
)

Test-only API

Attach a callback to be called right before a new ping is submitted. The provided function is called exactly once before submitting a ping.

Note: The callback will be called on any call to submit. A ping might not be sent afterwards, e.g. if the ping is otherwise empty (and send_if_empty is false).

impl PingType

pub fn submit(&self, __arg1: Option<&str>)

See glean_core::traits::Ping::submit

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 Ping for PingType

fn submit(&self, reason: Option<&str>)

Submits the ping for eventual uploading