Struct glean_core::metrics::PingType

pub struct PingType(/* private fields */);

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

impl PingType

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>, follows_collection_enabled: bool, uploader_capabilities: 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.
• uploader_capabilities - The ordered list of capabilities this ping requires to be uploaded with.

pub fn name(&self) -> &str

Get the name of this Ping

pub fn include_client_id(&self) -> bool

Whether the client ID will be included in the assembled ping when submitting.

pub fn send_if_empty(&self) -> bool

Whether the ping should be sent if empty.

pub fn precise_timestamps(&self) -> bool

Whether the ping will include precise timestamps for the start/end time.

pub fn include_info_sections(&self) -> bool

Whether client/ping_info sections will be included in this ping.

pub fn set_enabled(&self, enabled: bool)

Enable or disable a ping.

Disabling a ping causes all data for that ping to be removed from storage and all pending pings of that type to be deleted.

pub fn naively_enabled(&self) -> bool

Whether the enabled field of this ping is set. Note that there are multiple other reasons why a ping may or may not be enabled. See PingType::new and PingType::enabled for more details.

pub fn follows_collection_enabled(&self) -> bool

Whether this ping follows the collection_enabled flag See InnerPing member documentation for further details.

pub fn schedules_pings(&self) -> &[String]

Other pings that should be scheduled when this ping is sent.

pub fn reason_codes(&self) -> &[String]

Reason codes that this ping can send.

pub fn uploader_capabilities(&self) -> &[String]

The capabilities this ping requires to be uploaded under.

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 the ping_info.reason part of the payload.

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for PingType

type LiftType = Arc<PingType>

impl<UT> LowerError<UT> for PingType

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PingType

type ReturnType = <Arc<PingType> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for PingType

const TYPE_ID_META: MetadataBuffer = _