Struct Profile

pub struct Profile {

    pub sample_type: Vec<ValueType>,
    pub sample: Vec<Sample>,
    pub mapping: Vec<Mapping>,
    pub location: Vec<Location>,
    pub function: Vec<Function>,
    pub string_table: Vec<String>,
    pub drop_frames: i64,
    pub keep_frames: i64,
    pub time_nanos: i64,
    pub duration_nanos: i64,
    pub period_type: Option<ValueType>,
    pub period: i64,
    pub comment: Vec<i64>,
    pub default_sample_type: i64,
}

Fields

sample_type: Vec<ValueType>

A description of the samples associated with each Sample.value. For a cpu profile this might be: [[“cpu”,“nanoseconds”]] or [[“wall”,“seconds”]] or [[“syscall”,“count”]] For a heap profile, this might be: [[“allocations”,“count”], [“space”,“bytes”]], If one of the values represents the number of events represented by the sample, by convention it should be at index 0 and use sample_type.unit == “count”.

sample: Vec<Sample>

The set of samples recorded in this profile.

mapping: Vec<Mapping>

Mapping from address ranges to the image/binary/library mapped into that address range. mapping[0] will be the main binary.

location: Vec<Location>

Locations referenced by samples.

function: Vec<Function>

Functions referenced by locations.

string_table: Vec<String>

A common table for strings referenced by various messages. string_table[0] must always be “”.

drop_frames: i64

frames with Function.function_name fully matching the following regexp will be dropped from the samples, along with their successors.

Index into string table.

keep_frames: i64

frames with Function.function_name fully matching the following regexp will be kept, even if it matches drop_frames.

Index into string table.

time_nanos: i64

Time of collection (UTC) represented as nanoseconds past the epoch.

duration_nanos: i64

Duration of the profile, if a duration makes sense.

period_type: Option<ValueType>

The kind of events between sampled occurrences. e.g [ “cpu”,“cycles” ] or [ “heap”,“bytes” ]

period: i64

The number of events between sampled occurrences.

comment: Vec<i64>

Free-form text associated with the profile. The text is displayed as is to the user by the tools that read profiles (e.g. by pprof). This field should not be used to store any machine-readable information, it is only for human-friendly content. The profile must stay functional if this field is cleaned.

Indices into string table.

default_sample_type: i64

Index into the string table of the type of the preferred sample value. If unset, clients should default to the last sample value.

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Default for Profile

fn default() -> Self

Returns the “default value” for a type.

impl Message for Profile

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Profile

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