Struct WatchOptions 

pub struct WatchOptions {
    pub interest: Option<Status>,
    pub wake_on: Option<Status>,
    pub max_interval: Option<i64>,
    pub wake_on_max_interval: Option<bool>,
    /* private fields */
}

Configuration options for charger state watching.

interest and wake_on are optional masks: the actual field values within the Status table are ignored; only field presence (set vs. unset) determines the mask.

An absent mask means “use this field’s default”; a present but empty mask means “no fields”. The two defaults differ because the safe choice differs: interest defaults to everything the driver supports watching, so a client that never configures anything still makes progress, while wake_on defaults to nothing, since waking the system is a cost a client must opt into.

Fields

interest: Option<Status>

Fields the client wants to receive change notifications for. Defaults to every field the driver supports watching, as reported by Spec.supported_options. Pass an explicitly empty table to be notified only for the fields named in wake_on.

wake_on: Option<Status>

Fields that should actively wake the system from suspend. Any field present in wake_on is implicitly included in interest. Defaults to no fields: changes occurring during suspend are deferred until the next system wakeup and do not wake the device.

max_interval: Option<i64>

Maximum time between Watch responses. When set, the server completes a pending Watch with a freshly sampled Status once this much time has passed since the previous response, even if no field in interest changed. The time is measured on the boot timeline, so time spent suspended counts towards it. Defaults to absent: Watch only completes on changes. Servers that do not support periodic sampling omit this field from the effective options returned by ConfigureWatch and from Spec.supported_options. Servers may clamp the value, and report the interval they will honor in the effective options. Samples do not wake the system from suspend unless wake_on_max_interval is set: a sample that falls due while the system is suspended is taken once the system resumes.

wake_on_max_interval: Option<bool>

Whether a max_interval sample that falls due while the system is suspended wakes the system. Defaults to false; like wake_on, waking the system is a cost the client opts into. Ignored if max_interval is absent. Servers that cannot wake the system omit this field from the effective options returned by ConfigureWatch and from Spec.supported_options.

Trait Implementations

impl Clone for WatchOptions

fn clone(&self) -> WatchOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WatchOptions

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

Formats the value using the given formatter.

impl<D> Decode<WatchOptions, D> for WatchOptions

where D: ResourceDialect,

fn new_empty() -> WatchOptions

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 WatchOptions

fn default() -> WatchOptions

Returns the “default value” for a type.

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

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 WatchOptions

fn eq(&self, other: &WatchOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Persistable for WatchOptions

impl StructuralPartialEq for WatchOptions

impl TypeMarker for WatchOptions

type Owned = WatchOptions

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 WatchOptions

type Borrowed<'a> = &'a WatchOptions

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

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