Struct sync15::telemetry::SyncTelemetryPing

pub struct SyncTelemetryPing {
    version: u32,
    uid: Option<String>,
    events: Vec<Event>,
    syncs: Vec<SyncTelemetry>,
}

The Sync ping payload, as documented at https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/data/sync-ping.html. May have many syncs, may have many events. However, due to the architecture of apps which use these components, this payload is almost certainly not suitable for submitting directly. For example, we will always return a payload with exactly 1 sync, and it will not know certain other fields in the payload, such as the hashed FxA device ID (see https://searchfox.org/mozilla-central/rev/c3ebaf6de2d481c262c04bb9657eaf76bf47e2ac/services/sync/modules/browserid_identity.js#185 for an example of how the device ID is constructed). The intention is that consumers of this will use this to create a "real" payload - eg, accumulating until some threshold number of syncs is reached, and contributing additional data which only the consumer knows.

Fields

version: u32

uid: Option<String>

events: Vec<Event>

syncs: Vec<SyncTelemetry>

Implementations

impl SyncTelemetryPing

pub fn new() -> SyncTelemetryPing

pub fn uid(&mut self, uid: String)

pub fn sync(&mut self, s: SyncTelemetry)

pub fn event(&mut self, e: Event)

Trait Implementations

impl Debug for SyncTelemetryPing

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

Formats the value using the given formatter.

impl Default for SyncTelemetryPing

fn default() -> SyncTelemetryPing

Returns the "default value" for a type.

impl IntoFfi for SyncTelemetryPing where
    SyncTelemetryPing: Serialize, 

type Value = *mut i8

This type must be:

fn ffi_default() -> *mut i8

Return an 'empty' value. This is what's passed back to C in the case of an error, so it doesn't actually need to be "empty", so much as "ignorable". Note that this is also used when an empty Option<T> is returned.

fn into_ffi_value(self) -> *mut i8

Convert ourselves into a value we can pass back to C with confidence.

impl Serialize for SyncTelemetryPing

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.