Struct fidl_fuchsia_feedback::GetSnapshotParameters

pub struct GetSnapshotParameters {
    pub collection_timeout_per_data: Option<i64>,
    pub response_channel: Option<Channel>,
    /* private fields */
}

Parameters for the DataProvider::GetSnapshot() method.

Fields

collection_timeout_per_data: Option<i64>

A snapshot aggregates various data from the platform (device uptime, logs, Inspect data, etc.) that are collected in parallel. Internally, each data collection is done within a timeout.

collection_timeout_per_data allows clients to control how much time is given to each data collection. It enables clients to get a partial yet valid snapshot under a certain time.

Note that this does not control how much total time the snapshot generation may take, which is by construction higher than collection_timeout_per_data, as clients can control the total time by using a timeout on the call to GetSnapshot() on their side.

response_channel: Option<Channel>

If set, the snapshot archive will be sent as a |fuchsia.io.File| over this channel instead of being set in the |archive| field in the |Snapshot| response. This is typically useful if the client is on the host and does not support VMOs.

Implementations

impl GetSnapshotParameters

pub const EMPTY: Self = _

An empty table with every field set to None.

Trait Implementations

impl Debug for GetSnapshotParameters

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

Formats the value using the given formatter.

impl Decodable for GetSnapshotParameters

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 GetSnapshotParameters

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 GetSnapshotParameters

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

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

impl TopLevel for GetSnapshotParameters