Struct fidl_fuchsia_diagnostics::StreamParameters

pub struct StreamParameters {
    pub data_type: Option<DataType>,
    pub stream_mode: Option<StreamMode>,
    pub format: Option<Format>,
    pub client_selector_configuration: Option<ClientSelectorConfiguration>,
    pub batch_retrieval_timeout_seconds: Option<i64>,
    pub performance_configuration: Option<PerformanceConfiguration>,
    /* private fields */
}

Parameters needed to configure a stream of diagnostics information.

Fields

data_type: Option<DataType>

A [fuchsia.diagnostics/DataType] that specifies the diagnostics data type to stream to the client. NOTE: REQUIRED

stream_mode: Option<StreamMode>

A [fuchsia.diagnostics/StreamMode] that specifies how the streaming server provides streamed results. NOTE: REQUIRED

format: Option<Format>

A [fuchsia.diagnostics/Format] that specifies how to format the returned diagnostics data. NOTE: REQUIRED

client_selector_configuration: Option<ClientSelectorConfiguration>

Configuration specifying what results the client wants returned from their connection. The client can request a specific subset of data using a vector of provided selectors, or can specify that they want all available data. NOTE: REQUIRED

batch_retrieval_timeout_seconds: Option<i64>

Configuration specifying max number of seconds to wait for a single component to have its diagnostics data “pumped”. This value can used for testing or if you know the component you are interested is in under heavy load. If not provided, then PER_COMPONENT_ASYNC_TIMEOUT_SECONDS as defined in https://fuchsia.googlesource.com/fuchsia/+/refs/heads/master/src/diagnostics/archivist/src/constants.rs will be used. NOTE: OPTIONAL

performance_configuration: Option<PerformanceConfiguration>

Parameters which configure a diagnostics stream’s performance properties. NOTE: OPTIONAL

Implementations

impl StreamParameters

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Clone for StreamParameters

fn clone(&self) -> StreamParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamParameters

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

Formats the value using the given formatter.

impl Decodable for StreamParameters

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 StreamParameters

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 StreamParameters

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<StreamParameters> for StreamParameters

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

impl StructuralPartialEq for StreamParameters

impl TopLevel for StreamParameters