Struct TriggerConfig

pub struct TriggerConfig {
    pub trigger_mode: Option<i32>,
    pub use_clone_snapshot_if_available: Option<bool>,
    pub triggers: Vec<Trigger>,
    pub trigger_timeout_ms: Option<u32>,
}

Triggers allow producers to start or stop the tracing session when an event occurs.

For example if we are tracing probabilistically, most traces will be uninteresting. Triggers allow us to keep only the interesting ones such as those traces during which the device temperature reached a certain threshold. In this case the producer can activate a trigger to keep (STOP_TRACING) the trace, otherwise it can also begin a trace (START_TRACING) because it knows something is about to happen.

Fields

trigger_mode: Option<i32>

use_clone_snapshot_if_available: Option<bool>

This flag is really a workaround for b/274931668. This is needed only when deploying configs to different versions of the tracing service. When this is set to true this has the same effect of setting trigger_mode to CLONE_SNAPSHOT on newer versions of the service. This boolean has been introduced to allow to have configs that use CLONE_SNAPSHOT on newer versions of Android and fall back to STOP_TRACING on older versions where CLONE_SNAPSHOT did not exist. When using this flag, trigger_mode must be set to STOP_TRACING.

triggers: Vec<Trigger>

A list of triggers which are related to this configuration. If ANY trigger is seen then an action will be performed based on |trigger_mode|.

trigger_timeout_ms: Option<u32>

Required and must be positive if a TriggerConfig is specified. This is how long this TraceConfig should wait for a trigger to arrive. After this period of time if no trigger is seen the TracingSession will be cleaned up.

Implementations

impl TriggerConfig

pub fn trigger_mode(&self) -> TriggerMode

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

pub fn set_trigger_mode(&mut self, value: TriggerMode)

Sets trigger_mode to the provided enum value.

pub fn trigger_timeout_ms(&self) -> u32

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

pub fn use_clone_snapshot_if_available(&self) -> bool

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

Trait Implementations

impl Clone for TriggerConfig

fn clone(&self) -> TriggerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TriggerConfig

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

Formats the value using the given formatter.

impl Default for TriggerConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for TriggerConfig

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 TriggerConfig

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