Struct SetArgs

pub struct SetArgs {
    pub notifier: ClientEnd<NotifierMarker>,
    pub deadline: BootInstant,
    pub mode: SetMode,
    pub alarm_id: String,
}

Fields

notifier: ClientEnd<NotifierMarker>

Notifier to call when the alarm fires. When the server_end to this channel is dropped, the alarm will be canceled.

deadline: BootInstant

The deadline at which the timer is supposed to fire. This corresponds to a time instant on the boot timeline.

mode: SetMode

Optional mode that allows the API to support a number of use cases.

alarm_id: String

Set to a nonempty value to identify the alarm. A unique value of AlarmId must be picked per each unique alarm within a single FIDL connection’s scope.

Supplying an alarm_id for an already scheduled alarm reschedules that alarm.

Trait Implementations

impl Debug for SetArgs

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

Formats the value using the given formatter.

impl Decode<SetArgs, DefaultFuchsiaResourceDialect> for SetArgs

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<'_, DefaultFuchsiaResourceDialect>, offset: usize, _depth: Depth, ) -> Result<()>

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

impl Encode<SetArgs, DefaultFuchsiaResourceDialect> for &mut SetArgs

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, 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<T0: Encode<Endpoint<ClientEnd<NotifierMarker>>, DefaultFuchsiaResourceDialect>, T1: Encode<BootInstant, DefaultFuchsiaResourceDialect>, T2: Encode<SetMode, DefaultFuchsiaResourceDialect>, T3: Encode<BoundedString<128>, DefaultFuchsiaResourceDialect>> Encode<SetArgs, DefaultFuchsiaResourceDialect> for (T0, T1, T2, T3)

unsafe fn encode( self, encoder: &mut Encoder<'_, DefaultFuchsiaResourceDialect>, 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 SetArgs

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

type Borrowed<'a> = &'a mut SetArgs

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &mut Self::Owned. There are three cases:

fn take_or_borrow<'a>( value: &'a mut <Self as TypeMarker>::Owned, ) -> Self::Borrowed<'a>

Cheaply converts from &mut Self::Owned to Self::Borrowed. For HandleBased types this is “take” (it returns an owned handle and replaces value with Handle::invalid), and for all other types it is “borrow” (just converts from one reference to another).

impl TypeMarker for SetArgs

type Owned = SetArgs

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 Standalone<DefaultFuchsiaResourceDialect> for SetArgs

impl StructuralPartialEq for SetArgs