Enum SampleRequest 

pub enum SampleRequest {
    Set {
        sample_parameters: SampleParameters,
        control_handle: SampleControlHandle,
    },
    Commit {
        sink: ClientEnd<SampleSinkMarker>,
        responder: SampleCommitResponder,
    },
    #[non_exhaustive]
    _UnknownMethod {
        ordinal: u64,
        control_handle: SampleControlHandle,
        method_type: MethodType,
    },
}

Configure Archivist to alert you periodically about the state of data provided via SampleParameters.

If the given configuration results in a hit, a BatchIterator is sent over the sink provided. That iterator may be drained, and then the sink will go quiet until the next hit.

Archivist does not inform the client which data result in a success, because it has not inherent advantaged ability to do so. Clients who need to know which data was queried should cache their selectors and use selectors::select_from_hierarchy (or similar in C++).

Variants

Set

Add sample parameters.

Since this is limited by channel size, this API paginates at 300 items. That should fit in a channel unless a selector is particularly gigantic.

Use Commit to indicate that all samples are sent over.

Fields

sample_parameters: SampleParameters

control_handle: SampleControlHandle

Commit

Commit returns errors quickly, as all configuration is validated before the first sample is taken.

Fields

sink: ClientEnd<SampleSinkMarker>

responder: SampleCommitResponder

#[non_exhaustive]

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: SampleControlHandle

method_type: MethodType

Implementations

impl SampleRequest

pub fn into_set(self) -> Option<(SampleParameters, SampleControlHandle)>

pub fn into_commit( self, ) -> Option<(ClientEnd<SampleSinkMarker>, SampleCommitResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for SampleRequest

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

Formats the value using the given formatter.