pub struct PingType { /* private fields */ }
Expand description
A ping is a bundle of related metrics, gathered in a payload to be transmitted.
The ping payload will be encoded in JSON format and contains shared information data.
Implementations
sourceimpl PingType
impl PingType
sourcepub fn new<A: Into<String>>(
name: A,
include_client_id: bool,
send_if_empty: bool,
reason_codes: Vec<String>
) -> Self
pub fn new<A: Into<String>>(
name: A,
include_client_id: bool,
send_if_empty: bool,
reason_codes: Vec<String>
) -> Self
Creates a new ping type.
Arguments
name
- The name of the ping.include_client_id
- Whether to include the client ID in the assembled ping when.send_if_empty
- Whether the ping should be sent empty or not.reason_codes
- The valid reason codes for this ping.
sourcepub fn submit(&self, reason: Option<&str>)
pub fn submit(&self, reason: Option<&str>)
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.
sourcepub fn test_before_next_submit(
&self,
cb: impl FnOnce(Option<&str>) + Send + 'static
)
pub fn test_before_next_submit(
&self,
cb: impl FnOnce(Option<&str>) + Send + 'static
)
Test-only API
Attach a callback to be called right before a new ping is submitted. The provided function is called exactly once before submitting a ping.
Note: The callback will be called on any call to submit.
A ping might not be sent afterwards, e.g. if the ping is otherwise empty (and
send_if_empty
is false
).
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for PingType
impl Send for PingType
impl Sync for PingType
impl Unpin for PingType
impl UnwindSafe for PingType
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
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more