Struct Data

pub struct Data<D>
where
    D: DiagnosticsData,
{
    pub data_source: DataSource,
    pub metadata: <D as DiagnosticsData>::Metadata,
    pub moniker: ExtendedMoniker,
    pub payload: Option<DiagnosticsHierarchy<<D as DiagnosticsData>::Key>>,
    pub version: u64,
}

An instance of diagnostics data with typed metadata and an optional nested payload.

Fields

data_source: DataSource

The source of the data.

metadata: <D as DiagnosticsData>::Metadata

The metadata for the diagnostics payload.

moniker: ExtendedMoniker

Moniker of the component that generated the payload.

payload: Option<DiagnosticsHierarchy<<D as DiagnosticsData>::Key>>

Payload containing diagnostics data, if the payload exists, else None.

version: u64

Schema version.

Implementations

impl<D> Data<D>

where D: DiagnosticsData,

pub fn drop_payload(&mut self)

Returns a Data with an error indicating that the payload was dropped.

pub fn sort_payload(&mut self)

Sorts this Data’s payload if one is present.

pub fn filter(self, selectors: &[Selector]) -> Result<Option<Data<D>>, Error>

Uses a set of Selectors to filter self’s payload and returns the resulting Data. If the resulting payload is empty, it returns Ok(None).

impl Data<Inspect>

pub fn name(&self) -> &str

Access the name or filename within self.metadata.

impl Data<Logs>

pub fn for_logs( moniker: ExtendedMoniker, payload: Option<DiagnosticsHierarchy<LogsField>>, timestamp: impl Into<Instant<BootTimeline>>, component_url: Option<FlyStr>, severity: impl Into<Severity>, errors: Vec<LogError>, ) -> Data<Logs>

Creates a new data instance for logs.

pub fn set_raw_severity(&mut self, raw_severity: u8)

Sets the severity from a raw severity number. Overrides the severity to match the raw severity.

pub fn set_severity(&mut self, severity: Severity)

Sets the severity of the log. This will unset the raw severity.

pub fn msg(&self) -> Option<&str>

Returns the string log associated with the message, if one exists.

pub fn msg_mut(&mut self) -> Option<&mut String>

If the log has a message, returns a shared reference to the message contents.

pub fn payload_message(&self) -> Option<&DiagnosticsHierarchy<LogsField>>

If the log has message, returns an exclusive reference to it.

pub fn payload_keys(&self) -> Option<&DiagnosticsHierarchy<LogsField>>

If the log has structured keys, returns an exclusive reference to them.

pub fn payload_keys_strings(&self) -> Box<dyn Iterator<Item = String> + '_>

Returns an iterator over the payload keys as strings with the format “key=value”.

pub fn payload_message_mut( &mut self, ) -> Option<&mut DiagnosticsHierarchy<LogsField>>

If the log has a message, returns a mutable reference to it.

pub fn file_path(&self) -> Option<&str>

Returns the file path associated with the message, if one exists.

pub fn line_number(&self) -> Option<&u64>

Returns the line number associated with the message, if one exists.

pub fn pid(&self) -> Option<u64>

Returns the pid associated with the message, if one exists.

pub fn tid(&self) -> Option<u64>

Returns the tid associated with the message, if one exists.

pub fn tags(&self) -> Option<&Vec<String>>

Returns the tags associated with the message, if any exist.

pub fn severity(&self) -> Severity

Returns the severity level of this log.

pub fn dropped_logs(&self) -> Option<u64>

Returns number of dropped logs if reported in the message.

pub fn rolled_out_logs(&self) -> Option<u64>

Returns number of rolled out logs if reported in the message.

pub fn component_name(&self) -> Cow<'_, str>

Returns the component nam. This only makes sense for v1 components.

Trait Implementations

impl<D: DiagnosticsData> CheckResponse for Data<D>

fn has_payload(&self) -> bool

impl<D> Clone for Data<D>

where D: Clone + DiagnosticsData, <D as DiagnosticsData>::Metadata: Clone, <D as DiagnosticsData>::Key: Clone,

fn clone(&self) -> Data<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D> Debug for Data<D>

where D: Debug + DiagnosticsData, <D as DiagnosticsData>::Metadata: Debug, <D as DiagnosticsData>::Key: Debug,

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

Formats the value using the given formatter.

impl<'de, D> Deserialize<'de> for Data<D>

where D: DiagnosticsData, <D as DiagnosticsData>::Metadata: DeserializeOwned,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Data<D>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Data<Logs>

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

Formats the value using the given formatter.

impl Ord for Data<Logs>

fn cmp(&self, other: &Data<Logs>) -> 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.

impl<D> PartialEq for Data<D>

where D: PartialEq + DiagnosticsData, <D as DiagnosticsData>::Metadata: PartialEq, <D as DiagnosticsData>::Key: PartialEq,

fn eq(&self, other: &Data<D>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Data<Logs>

fn partial_cmp(&self, other: &Data<Logs>) -> 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<D> Serialize for Data<D>

where D: DiagnosticsData, <D as DiagnosticsData>::Metadata: Serialize,

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.

impl Eq for Data<Logs>

impl<D> StructuralPartialEq for Data<D>

where D: DiagnosticsData,