Struct DebugAnnotation

pub struct DebugAnnotation {
    pub proto_value: Option<Bytes>,
    pub dict_entries: Vec<DebugAnnotation>,
    pub array_values: Vec<DebugAnnotation>,
    pub name_field: Option<NameField>,
    pub value: Option<Value>,
    pub proto_type_descriptor: Option<ProtoTypeDescriptor>,
}

Proto representation of untyped key/value annotations provided in TRACE_EVENT macros. Users of the Perfetto SDK should prefer to use the perfetto::TracedValue API to fill these protos, rather than filling them manually.

Debug annotations are intended for debug use and are not considered a stable API of the trace contents. Trace-based metrics that use debug annotation values are prone to breakage, so please rely on typed TrackEvent fields for these instead.

DebugAnnotations support nested arrays and dictionaries. Each entry is encoded as a single DebugAnnotation message. Only dictionary entries set the “name” field. The TrackEvent message forms an implicit root dictionary.

Example TrackEvent with nested annotations: track_event { debug_annotations { name: “foo” dict_entries { name: “a” bool_value: true } dict_entries { name: “b” int_value: 123 } } debug_annotations { name: “bar” array_values { string_value: “hello” } array_values { string_value: “world” } } }

Next ID: 18. Reserved ID: 15

Fields

proto_value: Option<Bytes>

dict_entries: Vec<DebugAnnotation>

array_values: Vec<DebugAnnotation>

name_field: Option<NameField>

Name fields are set only for dictionary entries.

value: Option<Value>

proto_type_descriptor: Option<ProtoTypeDescriptor>

Used to embed arbitrary proto messages (which are also typically used to represent typed TrackEvent arguments). |proto_type_name| or |proto_type_name_iid| are storing the full name of the proto messages (e.g. .perfetto.protos.DebugAnnotation) and |proto_value| contains the serialised proto messages. See |TracedValue::WriteProto| for more details.

Implementations

impl DebugAnnotation

pub fn proto_value(&self) -> &[u8]

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

Trait Implementations

impl Clone for DebugAnnotation

fn clone(&self) -> DebugAnnotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DebugAnnotation

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

Formats the value using the given formatter.

impl Default for DebugAnnotation

fn default() -> Self

Returns the “default value” for a type.

impl Message for DebugAnnotation

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 DebugAnnotation

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