Enum MarkerFieldFormat

pub enum MarkerFieldFormat {
    Url,
    FilePath,
    SanitizedString,
    String,
    Duration,
    Time,
    Seconds,
    Milliseconds,
    Microseconds,
    Nanoseconds,
    Bytes,
    Percentage,
    Integer,
    Decimal,
}

The field format of a marker field.

Variants

Url

A URL, supports PII sanitization

FilePath

A file path, supports PII sanitization.

SanitizedString

A regular string, supports PII sanitization. Concretely this means that these strings are stripped when uploading profiles if you uncheck “Include resource URLs and paths”.

String

A plain String, never sanitized for PII.

Important: Do not put URL or file path information here, as it will not be sanitized during profile upload. Please be careful with including other types of PII here as well.

Duration

For time data that represents a duration of time. The value is given in float milliseconds and will be displayed in a unit that is picked based on the magnitude of the number. e.g. “Label: 5s, 5ms, 5μs”

Time

A timestamp, relative to the start of the profile. The value is given in float milliseconds.

e.g. “Label: 15.5s, 20.5ms, 30.5μs”

Seconds

Display a millisecond value as seconds, regardless of the magnitude of the number.

e.g. “Label: 5s” for a value of 5000.0

Milliseconds

Display a millisecond value as milliseconds, regardless of the magnitude of the number.

e.g. “Label: 5ms” for a value of 5.0

Microseconds

Display a millisecond value as microseconds, regardless of the magnitude of the number.

e.g. “Label: 5μs” for a value of 0.0005

Nanoseconds

Display a millisecond value as seconds, regardless of the magnitude of the number.

e.g. “Label: 5ns” for a value of 0.0000005

Bytes

Display a bytes value in a unit that’s appropriate for the number’s magnitude.

e.g. “Label: 5.55mb, 5 bytes, 312.5kb”

Percentage

This should be a value between 0 and 1. e.g. “Label: 50%” for a value of 0.5

Integer

A generic integer number. Do not use it for time information.

“Label: 52, 5,323, 1,234,567”

Decimal

A generic floating point number. Do not use it for time information.

“Label: 52.23, 0.0054, 123,456.78”

Implementations

impl MarkerFieldFormat

pub fn kind(&self) -> MarkerFieldFormatKind

Whether this field is a number field or a string field.

This determines whether we call number_field_value or string_field_value to get the field values.

Trait Implementations

impl Clone for MarkerFieldFormat

fn clone(&self) -> MarkerFieldFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MarkerFieldFormat

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

Formats the value using the given formatter.

impl PartialEq for MarkerFieldFormat

fn eq(&self, other: &MarkerFieldFormat) -> 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 Serialize for MarkerFieldFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MarkerFieldFormat

impl StructuralPartialEq for MarkerFieldFormat