pub enum PairingDelegateRequest {
    OnPairingRequest {
        peer: Peer,
        method: PairingMethod,
        displayed_passkey: u32,
        responder: PairingDelegateOnPairingRequestResponder,
    },
    OnPairingComplete {
        id: PeerId,
        success: bool,
        control_handle: PairingDelegateControlHandle,
    },
    OnRemoteKeypress {
        id: PeerId,
        keypress: PairingKeypress,
        control_handle: PairingDelegateControlHandle,
    },
}
Expand description

A Bluetooth Pairing Delegate is responsible for confirming or denying pairing requests received from Bluetooth peers that connect or are being connected to the local device.

Any new pairing will result in a call to PairingDelegate.OnPairingRequest, including pairings where the InputCapability and OutputCapability are set to none. The delegate is expected to have enough context to derive whether to accept or deny the pairing.

Only one delegate is allowed to be set per system at a time. See fuchsia.bluetooth.sys.Pairing for how to set the pairing delegate.

Variants§

§

OnPairingRequest

Fields

§peer: Peer
§displayed_passkey: u32

Called to confirm a pairing. The pairing process will be continued if accept response is true and rejected otherwise. If the pairing method requires a passkey it must be included as well. Pairing methods that do not require a passkey ignore the entered_passkey repsonse.

The pairing can fail (usually by timeout or peer disconnect) before the response is received. The OnPairingComplete method will be called when this occurs. Any response sent in this case will be ignored.

  • request peer information about the peer being paired
  • request method method of pairing active. See PairingMethod
  • request displayed_passkey a passkey to display to the user if PASSKEY_DISPLAY or PASSKEY_COMPARISON is being used. Meaningless otherwise.
  • response accept true if the pairing is accepted
  • response entered_passkey passkey entered by the user. Ignored unless method is PASSKEY_ENTRY.
§

OnPairingComplete

Fields

§id: PeerId
§success: bool

Called when the pairing procedure for a peer has been completed. This can be due to successful completion or an error (e.g. due to cancellation by the peer, a timeout, or disconnection).

  • request id The Bluetooth peer ID of the peer which was being paired.
  • request success true if the pairing succeeded, otherwise false.
§

OnRemoteKeypress

Fields

§id: PeerId

Called to notify keypresses from the peer device during pairing using PairingMethod.PASSKEY_DISPLAY.

This event is used to provide key press events to the delegate for a responsive user experience as the user types the passkey on the peer device. This event will be called once for each keypress.

This event will only be called between when an OnPairingRequest has been sent for id and when OnPairingComplete is sent.

Note: many devices do not send these events

  • request id The peer id of the peer that sent the keypress event.
  • request keypress The type of event which was received.

Implementations§

Trait Implementations§

source§

impl Debug for PairingDelegateRequest

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _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. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more