Skip to main content

Peripheral

Struct Peripheral 

Source
pub struct Peripheral { /* private fields */ }
Expand description

A local GATT server.

Implementations§

Source§

impl Peripheral

Source

pub fn new() -> (Self, Requests)

Open the peripheral role, returning the handle and its request stream.

Source

pub fn with_restoration(_restoration: Restoration) -> (Self, Requests)

Android has no state preservation, so the identifier is accepted and ignored — nothing here relaunches a process for Bluetooth.

Source

pub async fn availability(&self) -> Result<(), Availability>

Why the peripheral role is not usable, if it is not.

Source

pub async fn publish(&self, service: Service) -> Result<PublishedService>

Publish a service into the local GATT database.

A characteristic that can notify gets a Client Characteristic Configuration descriptor added automatically — Android does not, and without one no central can subscribe.

Source

pub fn unpublish_all(&self)

Remove every published service.

Source

pub async fn start_advertising(&self, advertising: Advertising) -> Result<()>

Start advertising.

Android will not put an arbitrary name in the payload — AdvertiseData only offers “include the device name”, and the device name is the adapter’s, shared by every app. So Advertising::local_name turns that flag on rather than setting a name.

Source

pub fn stop_advertising(&self)

Stop advertising.

Source

pub fn is_advertising(&self) -> bool

Whether the radio is currently advertising.

Source

pub async fn publish_l2cap_channel( &self, encryption_required: bool, ) -> Result<Psm>

Publish an L2CAP channel and return the PSM the system assigned.

Needs API 29. A thread accepts connections and reports each as Request::ChannelOpened, because accept() blocks.

Source

pub async fn unpublish_l2cap_channel(&self, psm: Psm) -> Result<()>

Withdraw a previously published PSM.

Source

pub async fn restored_state(&self) -> Option<RestoredPeripheral>

Always None: Android preserves nothing across a relaunch.

Trait Implementations§

Source§

impl Clone for Peripheral

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Peripheral

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
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.