Struct glean_core::ping::PingMaker

source ·
pub struct PingMaker;
Expand description

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

Implementations§

source§

impl PingMaker

source

pub fn new() -> Self

Creates a new PingMaker.

source

pub fn collect<'a>( &self, glean: &Glean, ping: &'a PingType, reason: Option<&str>, doc_id: &'a str, url_path: &'a str ) -> Option<Ping<'a>>

Collects 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.
  • reason - an optional reason code to include in the ping.
  • doc_id - the ping’s unique document identifier.
  • url_path - the path on the server to upload this ping to.
Returns

A fully assembled representation of the ping payload and associated metadata. If there is no data stored for the ping, None is returned.

source

pub fn store_ping(&self, data_path: &Path, ping: &Ping<'_>) -> Result<()>

Stores a ping to disk in the pings directory.

source

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

Clears any pending pings in the queue.

Trait Implementations§

source§

impl Default for PingMaker

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.