Struct 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

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<D: ResourceDialect> Decode<StreamParameters, D> for StreamParameters

fn new_empty() -> Self

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<()>

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

impl Default for StreamParameters

fn default() -> StreamParameters

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<StreamParameters, D> for &StreamParameters

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

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

impl PartialEq for StreamParameters

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

type Owned = StreamParameters

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 StreamParameters

type Borrowed<'a> = &'a StreamParameters

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: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

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

impl Persistable for StreamParameters

impl StructuralPartialEq for StreamParameters