Skip to main content

BuiltinClock

Enum BuiltinClock 

Source
#[repr(i32)]
pub enum BuiltinClock { Unknown = 0, Realtime = 1, RealtimeCoarse = 2, Monotonic = 3, MonotonicCoarse = 4, MonotonicRaw = 5, Boottime = 6, Tsc = 9, Perf = 10, TraceFile = 11, MaxId = 63, }
Expand description

Builtin clock domains used in Perfetto traces.

The default trace time clock is BUILTIN_CLOCK_TRACE_FILE: a synthetic clock representing the trace file’s own timeline. Each trace file gets its own instance (scoped by trace file index).

For backwards compatibility, Perfetto proto traces register BOOTTIME as a fallback: if the first timestamp conversion uses a clock other than the trace file clock and no explicit clock snapshot data exists, the trace time is switched to BOOTTIME. This fallback does not fire for modern traces that include ClockSnapshots or that only use the trace file clock directly.

The primary_trace_clock field in ClockSnapshot can definitively override the trace time clock regardless of the above.

Variants§

§

Unknown = 0

§

Realtime = 1

Corresponds to CLOCK_REALTIME. See clock_gettime(2).

§

RealtimeCoarse = 2

Corresponds to CLOCK_REALTIME_COARSE. See clock_gettime(2).

§

Monotonic = 3

Corresponds to CLOCK_MONOTONIC. See clock_gettime(2).

§

MonotonicCoarse = 4

Corresponds to CLOCK_MONOTONIC_COARSE. See clock_gettime(2).

§

MonotonicRaw = 5

Corresponds to CLOCK_MONOTONIC_RAW. See clock_gettime(2).

§

Boottime = 6

Corresponds to CLOCK_BOOTTIME. See clock_gettime(2). For proto traces, this is used as a backwards-compatible fallback trace time clock when no explicit clock snapshots are present.

§

Tsc = 9

TSC (Time Stamp Counter). Architecture-specific high-resolution counter.

§

Perf = 10

Corresponds to the perf event clock (PERF_CLOCK).

§

TraceFile = 11

A synthetic clock representing the trace file’s own timeline. Each trace file gets its own instance (scoped by trace file index). This is the default trace time clock before any clock snapshot or format-specific override takes effect.

§

MaxId = 63

Implementations§

Source§

impl BuiltinClock

Source

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of BuiltinClock.

Source

pub fn from_i32(value: i32) -> Option<BuiltinClock>

Converts an i32 to a BuiltinClock, or None if value is not a valid variant.

Source§

impl BuiltinClock

Source

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

Trait Implementations§

Source§

impl Clone for BuiltinClock

Source§

fn clone(&self) -> BuiltinClock

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BuiltinClock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BuiltinClock

Source§

fn default() -> BuiltinClock

Returns the “default value” for a type. Read more
Source§

impl From<BuiltinClock> for i32

Source§

fn from(value: BuiltinClock) -> i32

Converts to this type from the input type.
Source§

impl Hash for BuiltinClock

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for BuiltinClock

Source§

fn cmp(&self, other: &BuiltinClock) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for BuiltinClock

Source§

fn eq(&self, other: &BuiltinClock) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for BuiltinClock

Source§

fn partial_cmp(&self, other: &BuiltinClock) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for BuiltinClock

Source§

impl Eq for BuiltinClock

Source§

impl StructuralPartialEq for BuiltinClock

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.