Struct AdvertisingParameters

pub struct AdvertisingParameters {
    pub data: Option<AdvertisingData>,
    pub scan_response: Option<AdvertisingData>,
    pub mode_hint: Option<AdvertisingModeHint>,
    pub connectable: Option<bool>,
    pub connection_options: Option<ConnectionOptions>,
    pub advertising_procedure: Option<AdvertisingProcedure>,
    pub address_type: Option<AddressType>,
    /* private fields */
}

Represents the parameters for configuring advertisements.

Fields

data: Option<AdvertisingData>

The fields that will be encoded in the data section of advertising packets.

This field is required.

scan_response: Option<AdvertisingData>

The fields that are to be sent in a scan response packet. Clients may use this to send additional data that does not fit inside an advertising packet on platforms that do not support the advertising data length extensions.

If present advertisements will be configured to be scannable.

mode_hint: Option<AdvertisingModeHint>

The desired advertising frequency. See [fuchsia.bluetooth.le/AdvertisingModeHint]. Defaults to [fuchsia.bluetooth.le/AdvertisingModeHint.SLOW] if not present.

connectable: Option<bool>

If present and true then the controller will broadcast connectable advertisements which allows remote LE centrals to initiate a connection to the Peripheral. If false or otherwise not present then the advertisements will be non-connectable.

connection_options: Option<ConnectionOptions>

If present, the controller will broadcast connectable advertisements which allow peers to initiate connections to the Peripheral. The fields of ConnectionOptions will configure any connections set up from advertising.

advertising_procedure: Option<AdvertisingProcedure>

Specifies the advertising type to use (e.g. legacy, extended, etc).

If not present, we default to legacy advertising to maintain optimal compatibility with pre-Bluetooth 5.0 devices. See field descriptions within AdvertisingProcedure for more information.

address_type: Option<AddressType>

If privacy is not enabled, the address type will always be public.

If privacy is enabled and the client is not privileged, the address will be a random private address (either resolvable or non-resolvable). A non-privileged client requesting a public address will return an error.

If privacy is enabled and the client is privileged, they may request any address type, or will default to a random private address.

If this field is unset, the address type will be public or random depending on if privacy is enabled in the system.

Trait Implementations

impl Clone for AdvertisingParameters

fn clone(&self) -> AdvertisingParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdvertisingParameters

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

Formats the value using the given formatter.

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

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 AdvertisingParameters

fn default() -> AdvertisingParameters

Returns the “default value” for a type.

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

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 AdvertisingParameters

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

type Owned = AdvertisingParameters

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 AdvertisingParameters

type Borrowed<'a> = &'a AdvertisingParameters

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 AdvertisingParameters

impl StructuralPartialEq for AdvertisingParameters