Enum TriggerMode

#[repr(i32)]
pub enum TriggerMode {
    Unspecified = 0,
    StartTracing = 1,
    StopTracing = 2,
    CloneSnapshot = 4,
}

Variants

Unspecified = 0

StartTracing = 1

When this mode is chosen, data sources are not started until one of the |triggers| are received. This supports early initialization and fast starting of the tracing system. On triggering, the session will then record for |stop_delay_ms|. However if no trigger is seen after |trigger_timeout_ms| the session will be stopped and no data will be returned.

StopTracing = 2

When this mode is chosen, the session will be started via the normal EnableTracing() & StartTracing(). If no trigger is ever seen the session will be stopped after |trigger_timeout_ms| and no data will be returned. However if triggered the trace will stop after |stop_delay_ms| and any data in the buffer will be returned to the consumer.

CloneSnapshot = 4

When this mode is chosen, this causes a snapshot of the current tracing session to be created after |stop_delay_ms| while the current tracing session continues undisturbed (% an extra flush). This mode can be used only when the tracing session is handled by the “perfetto” cmdline client (which is true in 90% of cases). Part of the business logic necessary for this behavior, and ensuing file handling, lives in perfetto_cmd.cc . On other consumers, this causes only a notification of the trigger through a CloneTriggerHit ObservableEvent. The custom consumer is supposed to call CloneSession() itself after the event. Use use_clone_snapshot_if_available=true when targeting older versions of perfetto.

Implementations

impl TriggerMode

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of TriggerMode.

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

👎Deprecated: Use the TryFrom<i32> implementation instead

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

impl TriggerMode

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.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for TriggerMode

fn clone(&self) -> TriggerMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TriggerMode

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

Formats the value using the given formatter.

impl Default for TriggerMode

fn default() -> TriggerMode

Returns the “default value” for a type.

impl From<TriggerMode> for i32

fn from(value: TriggerMode) -> i32

Converts to this type from the input type.

impl Hash for TriggerMode

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TriggerMode

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TriggerMode

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<i32> for TriggerMode

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<TriggerMode, DecodeError>

Performs the conversion.

impl Copy for TriggerMode

impl Eq for TriggerMode

impl StructuralPartialEq for TriggerMode