Struct SampleDatum 

pub struct SampleDatum {
    pub selector: Option<SelectorArgument>,
    pub strategy: Option<SampleStrategy>,
    pub interval_secs: Option<i64>,
    /* private fields */
}

Fields

selector: Option<SelectorArgument>

The selector to check.

strategy: Option<SampleStrategy>

The strategy by which the server decides to notify the client.

interval_secs: Option<i64>

The interval at which this datum should be sampled.

Each SampleDatum has its own specified interval. It is preferred to send as many selectors on one Sample connection as possible, to allow Archivist to batch requests. However, Archivist will query at a period that is the greatest common divisor of all intervals. So, balance the desire for a small number of Sample connections with keeping the intervals compatible.

Example: two data with intervals of 3 and 4 respectively would check for work every second. Archivist won’t actually sample if neither batch is ready, but it will check.

Example: two data with intervals of 10 and 5 respectively would only check for work every 5 seconds.

(In practice, the calculated sample period must be valid. See MINIMUM_SAMPLE_PERIOD_SECONDS above.)

Trait Implementations

impl Clone for SampleDatum

fn clone(&self) -> SampleDatum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleDatum

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

Formats the value using the given formatter.

impl<D> Decode<SampleDatum, D> for SampleDatum

where D: ResourceDialect,

fn new_empty() -> SampleDatum

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

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

impl Default for SampleDatum

fn default() -> SampleDatum

Returns the “default value” for a type.

impl<D> Encode<SampleDatum, D> for &SampleDatum

where D: ResourceDialect,

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

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

impl PartialEq for SampleDatum

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

type Owned = SampleDatum

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 SampleDatum

type Borrowed<'a> = &'a SampleDatum

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

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

impl Persistable for SampleDatum

impl StructuralPartialEq for SampleDatum