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
sourceimpl PingMaker
impl PingMaker
sourcepub fn collect<'a>(
&self,
glean: &Glean,
ping: &'a PingType,
reason: Option<&str>,
doc_id: &'a str,
url_path: &'a str
) -> Option<Ping<'a>>
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
- theGlean
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.
sourcepub fn collect_string(
&self,
glean: &Glean,
ping: &PingType,
reason: Option<&str>
) -> Option<String>
pub fn collect_string(
&self,
glean: &Glean,
ping: &PingType,
reason: Option<&str>
) -> Option<String>
Collects a snapshot for the given ping from storage and attach required meta information.
Arguments
glean
- theGlean
instance to collect data from.ping
- the ping to collect for.reason
- an optional reason code to include in the ping.
Returns
A fully assembled ping payload in a string encoded as JSON.
If there is no data stored for the ping, None
is returned.
sourcepub fn store_ping(&self, data_path: &Path, ping: &Ping<'_>) -> Result<()>
pub fn store_ping(&self, data_path: &Path, ping: &Ping<'_>) -> Result<()>
Stores a ping to disk in the pings directory.
sourcepub fn clear_pending_pings(&self, data_path: &Path) -> Result<()>
pub fn clear_pending_pings(&self, data_path: &Path) -> Result<()>
Clears any pending pings in the queue.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for PingMaker
impl Send for PingMaker
impl Sync for PingMaker
impl Unpin for PingMaker
impl UnwindSafe for PingMaker
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more