Enum WeightType

pub enum WeightType {
    Samples,
    TracingMs,
    Bytes,
}

Specifies the meaning of the “weight” value of a thread’s samples.

Variants

Samples

The weight is an integer multiplier. For example, “this stack was observed n times when sampling at the specified interval.”

This affects the total + self score of each call node in the call tree, and the order in the tree because the tree is ordered from large “totals” to small “totals”. It also affects the width of the sample’s stack’s box in the flame graph.

TracingMs

The weight is a duration in (fractional) milliseconds.

Note that, since Profile::add_sample currently only accepts integer weight values, the usefulness of TracingMs is currently limited.

Bytes

The weight of each sample is a value in bytes.

This can be used for profiles with allocation stacks. It can also be used for “size” profiles which give a bytes breakdown of the contents of a file.

Trait Implementations

impl Clone for WeightType

fn clone(&self) -> WeightType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeightType

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

Formats the value using the given formatter.

impl Display for WeightType

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

Formats the value using the given formatter.

impl Serialize for WeightType

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.