Struct EnergyScanParameters

pub struct EnergyScanParameters {
    pub channels: Option<Vec<u16>>,
    pub dwell_time_ms: Option<u32>,
    /* private fields */
}

Describes the parameters of an energy scan.

Fields

channels: Option<Vec<u16>>

Subset of channels to scan.

If unspecified, all channels will be scanned.

dwell_time_ms: Option<u32>

Desired dwell time per-channel for the energy scan, measured in milliseconds.

Note that firmware limitations may prevent the exact dwell time from being used. In such cases an approximation will be used.

Implementations must be able to support dwell times of at least 5000ms (5 seconds). The exact supported dwell-time range is device/driver dependent.

Setting a value outside of the supported range of values for this device will result in the value being clamped to the closest valid value, so setting a value of zero will always request the smallest energy scan duration the device is capable of.

If unspecified, a dwell time of approximately 500ms will be used.

Trait Implementations

impl Clone for EnergyScanParameters

fn clone(&self) -> EnergyScanParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnergyScanParameters

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

Formats the value using the given formatter.

impl<D> Decode<EnergyScanParameters, D> for EnergyScanParameters

where D: ResourceDialect,

fn new_empty() -> EnergyScanParameters

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 EnergyScanParameters

fn default() -> EnergyScanParameters

Returns the “default value” for a type.

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

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 EnergyScanParameters

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

type Owned = EnergyScanParameters

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 EnergyScanParameters

type Borrowed<'a> = &'a EnergyScanParameters

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

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

impl Persistable for EnergyScanParameters

impl StructuralPartialEq for EnergyScanParameters