Struct bluer::Device

pub struct Device { /* fields omitted */ }

This is supported on crate feature bluetoothd only.

Interface to a Bluetooth device.

Implementations

impl Device

pub fn adapter_name(&self) -> &str

The Bluetooth adapter name.

pub fn address(&self) -> Address

The Bluetooth device address of the remote device.

pub async fn events(&self) -> Result<impl Stream<Item = DeviceEvent>>

Streams device property changes.

The stream ends when the device is removed.

pub async fn services(&self) -> Result<Vec<Service>>

Remote GATT services.

The device must be connected for GATT services to be resolved.

pub async fn service(&self, service_id: u16) -> Result<Service>

Remote GATT service with specified id.

pub async fn connect(&self) -> Result<()>

This is a generic method to connect any profiles the remote device supports that can be connected to and have been flagged as auto-connectable on our side.

If only subset of profiles is already connected it will try to connect currently disconnected ones.

If at least one profile was connected successfully this method will indicate success.

For dual-mode devices only one bearer is connected at time, the conditions are in the following order:

1. Connect the disconnected bearer if already connected.

2. Connect first the bonded bearer. If no bearers are bonded or both are skip and check latest seen bearer.

3. Connect last seen bearer, in case the timestamps are the same BR/EDR takes precedence.

pub async fn disconnect(&self) -> Result<()>

This method gracefully disconnects all connected profiles and then terminates low-level ACL connection.

ACL connection will be terminated even if some profiles were not disconnected properly e.g. due to misbehaving device.

This method can be also used to cancel a preceding Connect call before a reply to it has been received.

For non-trusted devices connected over LE bearer calling this method will disable incoming connections until Connect method is called again.

pub async fn connect_profile(&self, uuid: &Uuid) -> Result<()>

This method connects a specific profile of this device. The UUID provided is the remote service UUID for the profile.

pub async fn disconnect_profile(&self, uuid: &Uuid) -> Result<()>

This method disconnects a specific profile of this device.

The profile needs to be registered client profile.

There is no connection tracking for a profile, so as long as the profile is registered this will always succeed.

pub async fn pair(&self) -> Result<()>

This method will connect to the remote device, initiate pairing and then retrieve all SDP records (or GATT primary services).

If the application has registered its own agent, then that specific agent will be used. Otherwise it will use the default agent.

Only for applications like a pairing wizard it would make sense to have its own agent. In almost all other cases the default agent will handle this just fine.

In case there is no application agent and also no default agent present, this method will fail.

Drop the returned future to cancel pairing.

impl Device

pub async fn name(&self) -> Result<Option<String>>

The Bluetooth remote name.

This value can not be changed. Use the Alias property instead.

This value is only present for completeness. It is better to always use the Alias property when displaying the devices name.

If the Alias property is unset, it will reflect this value which makes it more convenient.

pub async fn address_type(&self) -> Result<AddressType>

The Bluetooth device address type.

For dual-mode and BR/EDR only devices this defaults to “public”. Single mode LE devices may have either value. If remote device uses privacy than before pairing this represents address type used for connection and Identity Address after pairing.

pub async fn icon(&self) -> Result<Option<String>>

Proposed icon name according to the freedesktop.org icon naming specification.

pub async fn class(&self) -> Result<Option<u32>>

The Bluetooth class of device of the remote device.

pub async fn appearance(&self) -> Result<Option<u16>>

External appearance of device, as found on GAP service.

pub async fn uuids(&self) -> Result<Option<HashSet<Uuid>>>

List of 128-bit UUIDs that represents the available remote services.

pub async fn is_paired(&self) -> Result<bool>

Indicates if the remote device is paired.

pub async fn is_connected(&self) -> Result<bool>

Indicates if the remote device is paired.

pub async fn is_trusted(&self) -> Result<bool>

Indicates if the remote is seen as trusted. This setting can be changed by the application.

pub async fn set_trusted(&self, v: bool) -> Result<()>

Indicates if the remote is seen as trusted. This setting can be changed by the application.

pub async fn is_blocked(&self) -> Result<bool>

If set to true any incoming connections from the device will be immediately rejected.

Any device drivers will also be removed and no new ones will be probed as long as the device is blocked.

pub async fn set_blocked(&self, v: bool) -> Result<()>

If set to true any incoming connections from the device will be immediately rejected.

Any device drivers will also be removed and no new ones will be probed as long as the device is blocked.

pub async fn is_wake_allowed(&self) -> Result<bool>

If set to true this device will be allowed to wake the host from system suspend.

pub async fn set_wake_allowed(&self, v: bool) -> Result<()>

If set to true this device will be allowed to wake the host from system suspend.

pub async fn alias(&self) -> Result<String>

The name alias for the remote device.

The alias can be used to have a different friendly name for the remote device.

In case no alias is set, it will return the remote device name. Setting an empty string as alias will convert it back to the remote device name.

When resetting the alias with an empty string, the property will default back to the remote name.

pub async fn set_alias(&self, v: String) -> Result<()>

The name alias for the remote device.

The alias can be used to have a different friendly name for the remote device.

In case no alias is set, it will return the remote device name. Setting an empty string as alias will convert it back to the remote device name.

When resetting the alias with an empty string, the property will default back to the remote name.

pub async fn is_legacy_pairing(&self) -> Result<bool>

Set to true if the device only supports the pre-2.1 pairing mechanism.

This property is useful during device discovery to anticipate whether legacy or simple pairing will occur if pairing is initiated.

Note that this property can exhibit false-positives in the case of Bluetooth 2.1 (or newer) devices that have disabled Extended Inquiry Response support.

pub async fn modalias(&self) -> Result<Option<Modalias>>

Remote Device ID information in modalias format used by the kernel and udev.

pub async fn rssi(&self) -> Result<Option<i16>>

Received Signal Strength Indicator of the remote device (inquiry or advertising).

None if the device is known, but not currently present.

pub async fn tx_power(&self) -> Result<Option<i16>>

Advertised transmitted power level (inquiry or advertising).

pub async fn manufacturer_data(&self) -> Result<Option<HashMap<u16, Vec<u8>>>>

Manufacturer specific advertisement data.

Keys are 16 bits Manufacturer ID followed by its byte array value.

pub async fn service_data(&self) -> Result<Option<HashMap<Uuid, Vec<u8>>>>

Service advertisement data.

Keys are the UUIDs followed by its byte array value.

pub async fn is_services_resolved(&self) -> Result<bool>

Indicate whether or not service discovery has been resolved.

pub async fn advertising_flags(&self) -> Result<Vec<u8>>

The Advertising Data Flags of the remote device.

pub async fn advertising_data(&self) -> Result<HashMap<u8, Vec<u8>>>

The Advertising Data of the remote device.

Note: Only types considered safe to be handled by application are exposed.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.