Struct glean_core::metrics::PingType
source · pub struct PingType(/* private fields */);
Expand description
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.
Implementations§
source§impl PingType
impl PingType
sourcepub fn new<A: Into<String>>(
name: A,
include_client_id: bool,
send_if_empty: bool,
precise_timestamps: bool,
include_info_sections: bool,
enabled: bool,
schedules_pings: Vec<String>,
reason_codes: Vec<String>
) -> Self
pub fn new<A: Into<String>>( name: A, include_client_id: bool, send_if_empty: bool, precise_timestamps: bool, include_info_sections: bool, enabled: bool, schedules_pings: Vec<String>, 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.precise_timestamps
- Whether the ping should use precise timestamps for the start and end time.include_info_sections
- Whether the ping should include the client/ping_info sections.enabled
- Whether or not this ping is enabled. Note: Data that would be sent on a disabled ping will still be collected but is discarded rather than being submitted.reason_codes
- The valid reason codes for this ping.
sourcepub fn submit(&self, reason: Option<String>)
pub fn submit(&self, reason: Option<String>)
Submits the ping for eventual uploading.
The ping content is assembled as soon as possible, but upload is not guaranteed to happen immediately, as that depends on the upload policies.
If the ping currently contains no content, it will not be sent, unless it is configured to be sent if empty.
§Arguments
reason
- the reason the ping was triggered. Included in theping_info.reason
part of the payload.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for PingType
impl RefUnwindSafe for PingType
impl Send for PingType
impl Sync for PingType
impl Unpin for PingType
impl UnwindSafe for PingType
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
source§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>