Struct DataSourceDescriptor

pub struct DataSourceDescriptor {
    pub name: Option<String>,
    pub id: Option<u64>,
    pub will_notify_on_stop: Option<bool>,
    pub will_notify_on_start: Option<bool>,
    pub handles_incremental_state_clear: Option<bool>,
    pub no_flush: Option<bool>,
    pub gpu_counter_descriptor: Option<GpuCounterDescriptor>,
    pub track_event_descriptor: Option<TrackEventDescriptor>,
    pub ftrace_descriptor: Option<FtraceDescriptor>,
}

This message is sent from Producer(s) to the tracing Service when registering to advertise their capabilities. It describes the structure of tracing protos that will be produced by the data source and the supported filters.

Fields

name: Option<String>

e.g., “linux.ftrace”, “chromium.tracing”

id: Option<u64>

When non-zero, this is a unique ID within the scope of the Producer for this data source (it is NOT globally unique). This is useful to differentiate between data sources with matching names when calling UpdateDataSource(). This field has been introduced in November 2021 (v22, Android T) and is not supported on older versions.

will_notify_on_stop: Option<bool>

When true the data source is expected to ack the stop request through the NotifyDataSourceStopped() IPC. This field has been introduced after Android P in Jul 2018 and is not supported on older versions.

will_notify_on_start: Option<bool>

When true the data source is expected to ack the start request through the NotifyDataSourceStarted() IPC. This field has been introduced after Android P in March 2019 and is not supported on older versions.

handles_incremental_state_clear: Option<bool>

If true, opt into receiving the ClearIncrementalState() IPC. This should be set if the data source writes packets that refer to previous trace contents, and knows how to stop referring to the already-emitted data.

no_flush: Option<bool>

If true, indicates that the data source does nothing upon Flush. This allows the service to reduce the flush-related IPC traffic and better deal with frozen producers (see go/perfetto-frozen). This is usually the case for data sources like ‘track_event’ that don’t have access to the various thread task runners to post a flush task and rely purely on server-side scraping. Introduced in v39 / Android V.

gpu_counter_descriptor: Option<GpuCounterDescriptor>

Optional specification about available GPU counters.

track_event_descriptor: Option<TrackEventDescriptor>

ftrace_descriptor: Option<FtraceDescriptor>

Implementations

impl DataSourceDescriptor

pub fn name(&self) -> &str

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

pub fn will_notify_on_stop(&self) -> bool

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

pub fn will_notify_on_start(&self) -> bool

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

pub fn handles_incremental_state_clear(&self) -> bool

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

pub fn id(&self) -> u64

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

pub fn no_flush(&self) -> bool

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

Trait Implementations

impl Clone for DataSourceDescriptor

fn clone(&self) -> DataSourceDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataSourceDescriptor

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

Formats the value using the given formatter.

impl Default for DataSourceDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Message for DataSourceDescriptor

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 DataSourceDescriptor

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