Struct Filter

pub struct Filter {
    pub service_uuid: Option<Uuid>,
    pub service_data_uuid: Option<Uuid>,
    pub manufacturer_id: Option<u16>,
    pub connectable: Option<bool>,
    pub name: Option<String>,
    pub max_path_loss: Option<i8>,
    pub solicitation_uuid: Option<Uuid>,
    /* private fields */
}

Filter parameters for use during a scan. A discovered peer only matches the filter if it satisfies all of the present filter parameters.

Fields

service_uuid: Option<Uuid>

Filter based on advertised service UUID.

service_data_uuid: Option<Uuid>

Filter based on service data containing the given UUID.

manufacturer_id: Option<u16>

Filter based on a manufacturer 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. Manufacturer identifiers can be found at https://www.bluetooth.com/specifications/assigned-numbers/company-identifiers/

connectable: Option<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 broadcasters by setting this to false.

name: Option<String>

Filter results based on a portion of the advertised device name. Substring matches are allowed.

max_path_loss: Option<i8>

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.

NOTE: This field is calculated using the RSSI and TX Power information obtained from advertising and scan response data during a scan procedure. It should NOT be confused with information for an active connection obtained using the “Path Loss Reporting” feature.

solicitation_uuid: Option<Uuid>

Filter based on a service solicitation by service UUID. Service solicitation is an invitation to a peer to connect if they provide a service we want to use.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

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

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 Default for Filter

fn default() -> Filter

Returns the “default value” for a type.

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

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 Filter

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

type Owned = Filter

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 Filter

type Borrowed<'a> = &'a Filter

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 Filter

impl StructuralPartialEq for Filter