Struct Timebase

pub struct Timebase {
    pub timestamp_clock: Option<i32>,
    pub name: Option<String>,
    pub interval: Option<Interval>,
    pub event: Option<Event>,
}

The primary event to count. If recording multiple events, this counter is the “group leader”. Commented from the perspective of its use in |PerfEventConfig|. Next id: 12

Fields

timestamp_clock: Option<i32>

If set, samples will be timestamped with the given clock. If unset, the clock is chosen by the implementation. For software events, prefer PERF_CLOCK_BOOTTIME. However it cannot be used for hardware events (due to interrupt safety), for which the recommendation is to use one of the monotonic clocks.

name: Option<String>

Optional arbitrary name for the event, to identify it in the parsed trace. Does not affect the profiling itself. If unset, the trace parser will choose a suitable name.

interval: Option<Interval>

How often to snapshot the counter, along with any follower events and any additional sampled data such as callstacks.

This choice also controls how the readings are taken:

• With |frequency| or |period|, samples are taken by the kernel into a ring buffer. Analogous to perf record.
• With |poll_period_ms|, the userspace periodically snapshots the counters using the read syscall. Analogous to perf stat -I. Prefer the sampling options unless you’re recording PMUs whose perf drivers only support the reading mode.

If unset, an implementation-defined sampling default is used.

event: Option<Event>

Counting event to use as the timebase. If unset, implies the CPU timer (SW_CPU_CLOCK) as the event, which is what you usually want.

Implementations

impl Timebase

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn timestamp_clock(&self) -> PerfClock

Returns the enum value of timestamp_clock, or the default if the field is unset or set to an invalid enum value.

pub fn set_timestamp_clock(&mut self, value: PerfClock)

Sets timestamp_clock to the provided enum value.

Trait Implementations

impl Clone for Timebase

fn clone(&self) -> Timebase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timebase

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

Formats the value using the given formatter.

impl Default for Timebase

fn default() -> Self

Returns the “default value” for a type.

impl Message for Timebase

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for Timebase

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