Struct ScanFilter

pub struct ScanFilter {
    pub service_uuids: Option<Vec<String>>,
    pub service_data_uuids: Option<Vec<String>>,
    pub manufacturer_identifier: Option<Box<UInt16>>,
    pub connectable: Option<Box<Bool>>,
    pub name_substring: Option<String>,
    pub max_path_loss: Option<Box<Int8>>,
}

Filter parameters for use during a scan. A discovered peripheral or broadcaster will be reported to applications only if it satisfies all of the provided filter parameters. Null fields will be ignored.

Fields

service_uuids: Option<Vec<String>>

Filter based on advertised service UUIDs. A peripheral that advertises at least one of the entries in service_uuids will satisfy this filter.

service_data_uuids: Option<Vec<String>>

Filter based on service data containing one of the given UUIDs.

manufacturer_identifier: Option<Box<UInt16>>

Filter based on a company identifier present in the manufacturer data. If this filter parameter is set, then the advertising payload must contain manufacturer specific data with the provided company identifier to satisfy this filter.

connectable: Option<Box<Bool>>

Filter based on whether or not a device is connectable. For example, a client that is only interested in peripherals that it can connect to can set this to true. Similarly a client can scan only for braodcasters by setting this to false.

name_substring: Option<String>

Filter results based on a portion of the advertised device name.

max_path_loss: Option<Box<Int8>>

Filter results based on the path loss of the radio wave. A device that matches this filter must satisfy the following:

1. Radio transmission power level and received signal strength must be available for the path loss calculation;
2. The calculated path loss value must be less than, or equal to, max_path_loss.

Trait Implementations

impl Clone for ScanFilter

fn clone(&self) -> ScanFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScanFilter

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<ScanFilter, D> for ScanFilter

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

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

impl<D: ResourceDialect> Encode<ScanFilter, D> for &ScanFilter

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, 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<D: ResourceDialect, T0: Encode<Optional<UnboundedVector<BoundedString<36>>>, D>, T1: Encode<Optional<UnboundedVector<BoundedString<36>>>, D>, T2: Encode<Boxed<UInt16>, D>, T3: Encode<Boxed<Bool>, D>, T4: Encode<Optional<BoundedString<248>>, D>, T5: Encode<Boxed<Int8>, D>> Encode<ScanFilter, D> for (T0, T1, T2, T3, T4, T5)

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

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

type Owned = ScanFilter

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 ScanFilter

type Borrowed<'a> = &'a ScanFilter

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

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

impl Persistable for ScanFilter

impl StructuralPartialEq for ScanFilter