Struct fidl_fuchsia_feedback::ComponentData

pub struct ComponentData {
    pub namespace: Option<String>,
    pub annotations: Option<Vec<Annotation>>,
    /* private fields */
}

Data known to a component, but not exposed to the platform, to attach to feedback reports.

Fields

namespace: Option<String>

The top-level namespace associated with the data:

• Is intended to group related data together and reduce data key collisions across namespaces.
• May be shared by multiple clients, e.g., there could be multiple clients within the same component or across components that want to expose related data and they would all use the same namespace.
• Will be prefixed to every data key passed within that namespace in all feedback reports, e.g., the annotation “version” would appear as “foo.version” in all feedback reports if the namespace is “foo”.
• Must match [a-z-]+, i.e. only lowercase letters and hyphens or this will result in a ZX_ERR_INVALID_ARGS epitaph.
• Must not match a reserved namespace used internally for platform data, e.g., “build”, or this will result in a ZX_ERR_INVALID_ARGS epitaph. The list of reserved namespaces is internal and subject to change for now.

annotations: Option<Vec<Annotation>>

A vector of key-value string pairs, e.g., <"version", "1.2.3.45">.

Keys:

• Should be unique as only the latest value for a given key in the vector will be considered.
• Must match [a-z-.]+, i.e. only lowercase letters, hyphens and periods. Use periods for sub-namespacing, e.g., “build.label” and “build.type”, so that related annotations are grouped together (here related to “build”) when sorted lexicographically.

Implementations

impl ComponentData

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Clone for ComponentData

fn clone(&self) -> ComponentData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentData

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

Formats the value using the given formatter.

impl Decodable for ComponentData

fn new_empty() -> Self

Creates a new value of this type with an “empty” representation.

fn decode(&mut self, decoder: &mut Decoder<'_>, offset: usize) -> Result<()>

Decodes an object of this type from the decoder’s buffers into self. Callers must ensure that offset is a multiple of Layout::inline_align, and that decoder.buf has room for reading Layout::inline_size bytes at offset.

impl Encodable for ComponentData

fn encode( &mut self, encoder: &mut Encoder<'_, '_>, offset: usize, recursion_depth: usize ) -> Result<()>

Encode the object into the buffer. Any handles stored in the object are swapped for Handle::INVALID. Callers must ensure that offset is a multiple of Layout::inline_align, and that encoder.buf has room for writing Layout::inline_size bytes at offset.

impl Layout for ComponentData

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 the type’s alignment. Must be a multiple of inline_align.

fn supports_simple_copy() -> boolwhere Self: Sized,

Returns true iff the type can be encoded or decoded via simple copy.

impl PartialEq<ComponentData> for ComponentData

fn eq(&self, other: &ComponentData) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Persistable for ComponentData

impl StructuralPartialEq for ComponentData

impl TopLevel for ComponentData