Struct glean_core::ping::PingMaker

pub struct PingMaker;

Collect a ping's data, assemble it into its full payload and store it on disk.

Methods

impl PingMaker

pub fn new() -> Self

Create a new PingMaker.

pub fn collect(&self, glean: &Glean, ping: &PingType) -> Option<JsonValue>

Collect a snapshot for the given ping from storage and attach required meta information.

Arguments

• glean - the Glean instance to collect data from.
• ping - the ping to collect for.

Return value

Returns a fully assembled JSON representation of the ping payload. If there is no data stored for the ping, None is returned.

pub fn collect_string(&self, glean: &Glean, ping: &PingType) -> Option<String>

Collect a snapshot for the given ping from storage and attach required meta information, returning it as a string containing JSON.

Arguments

• glean - the Glean instance to collect data from.
• ping - the ping to collect for.

Return value

Returns a fully assembled ping payload in a string encoded as JSON. If there is no data stored for the ping, None is returned.

pub fn store_ping(
    &self,
    doc_id: &str,
    ping_name: &str,
    data_path: &Path,
    url_path: &str,
    ping_content: &JsonValue
) -> Result<()>

Store a ping to disk in the pings directory.

pub fn clear_pending_pings(&self, data_path: &Path) -> Result<()>

Clear any pending pings in the queue.

Trait Implementations

impl Default for PingMaker

fn default() -> Self

Returns the "default value" for a type.