Skip to main content

Characteristic

Struct Characteristic 

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

A Bluetooth GATT characteristic.

Implementations§

Source§

impl Characteristic

Source

pub fn uuid(&self) -> Uuid

The Uuid identifying the type of this GATT characteristic.

Source

pub async fn uuid_async(&self) -> Result<Uuid>

This method is kept for compatibility with bluest.

Source

pub async fn properties(&self) -> Result<CharacteristicProperties>

The properties of this this GATT characteristic.

Characteristic properties indicate which operations (e.g. read, write, notify, etc) may be performed on this characteristic.

Source

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

The cached value of this characteristic. Returns an error if the value has not yet been read.

Source

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

Read the value of this characteristic from the device.

Source

pub async fn write(&self, value: &[u8]) -> Result<()>

Write value to this characteristic on the device and request the device to return a response indicating a successful write.

Source

pub async fn write_without_response(&self, value: &[u8]) -> Result<()>

Write value to this characteristic on the device without requesting a response.

Source

pub fn max_write_len(&self) -> Result<usize>

Get the maximum amount of data that can be written in a single packet for this characteristic.

The Android API does not provide a method to query the current MTU value directly; instead, BluetoothGatt.requestMtu() may be called in Adapter::connect_device to have a possible maximum MTU in the callback. This can be configured with crate::AdapterConfig::request_mtu_on_connect.

Source

pub async fn max_write_len_async(&self) -> Result<usize>

This method is kept for compatibility with bluest.

Source

pub async fn notify( &self, ) -> Result<impl Stream<Item = Result<Vec<u8>>> + Send + Unpin + '_>

Enables notification of value changes for this GATT characteristic.

Returns a stream of values for the characteristic sent from the device.

Source

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

Is the device currently sending notifications for this characteristic?

Source

pub async fn discover_descriptors(&self) -> Result<Vec<Descriptor>>

This method is kept for compatibility with bluest.

Source

pub async fn descriptors(&self) -> Result<Vec<Descriptor>>

Get previously discovered descriptors.

Trait Implementations§

Source§

impl Clone for Characteristic

Source§

fn clone(&self) -> Characteristic

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Characteristic

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Characteristic

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Characteristic

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Characteristic

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 = 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>,

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.