Struct AnalyticsDiagnostic 

pub struct AnalyticsDiagnostic {
    pub kind: AnalyticsDiagnosticKind,
    pub scope: String,
    pub date: Option<String>,
    pub event_id: Option<String>,
    pub message: String,
    pub remedy: Option<String>,
}

One analytics finding, with everything a surface needs to explain it (data-model.md §7).

scope is the stable scope id, not the display string: the finding has to survive the scope’s Display changing, and a payload consumer keys on the id. date and event_id are Option because a finding is not always about one day or one event — an invalid period is about the whole series.

Fields

kind: AnalyticsDiagnosticKind

What is wrong.

scope: String

The stable id of the scope the finding is about.

date: Option<String>

The day the finding is about, when it is about one.

event_id: Option<String>

The stable event id the finding is about, when it is about one.

message: String

What is wrong, in one sentence — the reason half of the #1643 shape.

remedy: Option<String>

What the reader can do about it — the remedy half of the #1643 shape.

Implementations

impl AnalyticsDiagnostic

pub fn new( kind: AnalyticsDiagnosticKind, scope: impl Into<String>, message: impl Into<String>, ) -> Self

A finding with its reason; the remedy comes from AnalyticsDiagnosticKind::default_remedy.

pub fn on(self, date: impl Into<String>) -> Self

Place the finding on a day.

pub fn about_event(self, event_id: impl Into<String>) -> Self

Name the recorded event the finding is about.

pub fn with_remedy(self, remedy: impl Into<String>) -> Self

Replace the kind’s default remedy with one this finding can be more exact about.

pub fn render(&self) -> String

Render through the crate’s one renderer — identical bytes on every surface.

Trait Implementations

impl Clone for AnalyticsDiagnostic

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnalyticsDiagnostic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AnalyticsDiagnostic

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AnalyticsDiagnostic

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

Formats the value using the given formatter.

impl Eq for AnalyticsDiagnostic

impl Ord for AnalyticsDiagnostic

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for AnalyticsDiagnostic

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for AnalyticsDiagnostic

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AnalyticsDiagnostic

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AnalyticsDiagnostic