Struct TraceConfig

pub struct TraceConfig {
    pub categories: Option<Vec<String>>,
    pub buffer_size_megabytes_hint: Option<u32>,
    pub start_timeout_milliseconds: Option<u64>,
    pub buffering_mode: Option<BufferingMode>,
    pub provider_specs: Option<Vec<ProviderSpec>>,
    pub version: Option<FxtVersion>,
    pub defer_transfer: Option<bool>,
    /* private fields */
}

Provides options for the trace.

Fields

categories: Option<Vec<String>>

The trace categories to record, or an empty array for all.

buffer_size_megabytes_hint: Option<u32>

Suggested size of trace buffer which each provider should receive.

start_timeout_milliseconds: Option<u64>

Acknowledge start request after at most start_timeout_milliseconds.

buffering_mode: Option<BufferingMode>

provider_specs: Option<Vec<ProviderSpec>>

Overrides for particular providers.

version: Option<FxtVersion>

Maximum trace format version supported byt the client. If not set, this defaults to the latest available trace format version.

defer_transfer: Option<bool>

When true, the session will buffer the trace within the fuchsia.tracing.controller server and only send the trace over the output socket to the client once the trace completes.

It is recommended that defering the trace transfer be set to true when using streaming mode and the fuchsia.tracing.controller client is across the host-device boundary, such as with ffx. In this, or other cases where sending the trace data could cause exess cpu overhead, the disk writing cost is preferrable to the cost of sending to the client.

NOTE: defer_transfer only has effect during BufferingMode.STREAMING as other modes don’t otherwise send trace data to the client during a trace.

Trait Implementations

impl Clone for TraceConfig

fn clone(&self) -> TraceConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TraceConfig

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

Formats the value using the given formatter.

impl<D> Decode<TraceConfig, D> for TraceConfig

where D: ResourceDialect,

fn new_empty() -> TraceConfig

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for TraceConfig

fn default() -> TraceConfig

Returns the “default value” for a type.

impl<D> Encode<TraceConfig, D> for &TraceConfig

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for TraceConfig

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

type Owned = TraceConfig

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for TraceConfig

type Borrowed<'a> = &'a TraceConfig

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<TraceConfig as TypeMarker>::Owned, ) -> <TraceConfig as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for TraceConfig

impl StructuralPartialEq for TraceConfig