Struct Characteristic 

pub struct Characteristic<T: AsGatt + ?Sized> {
    pub cccd_handle: Option<u16>,
    pub handle: u16,
    pub end_handle: u16,
    pub props: CharacteristicProps,
    pub uuid: Uuid,
    /* private fields */
}

A characteristic in the attribute table.

Fields

cccd_handle: Option<u16>

Handle value assigned to the Client Characteristic Configuration Descriptor (if any)

handle: u16

Handle value assigned to this characteristic when it is added to the Gatt Attribute Table

end_handle: u16

Last attribute handle belonging to this characteristic (value handle + descriptors)

props: CharacteristicProps

Properties of this characteristic

uuid: Uuid

UUID of this characteristic

Implementations

impl<T: AsGatt + ?Sized> Characteristic<T>

pub fn should_notify<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, ) -> bool

Check if notifications should be sent to connection for this characteristic.

pub async fn notify<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, value: &T, store: bool, ) -> Result<(), Error>

Send a notification to connection with a new value for the characteristic.

If store is true, the new value will be written to the table before sending the notification.

If the provided connection has not subscribed for this characteristic, it will not be notified.

If the characteristic does not support notifications, an error is returned.

pub async fn notify_raw<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, value: &[u8], store: bool, ) -> Result<(), Error>

Send a notification to connection with a new value for the characteristic.

If store is true, the new value will be written to the table before sending the notification.

If the provided connection has not subscribed for this characteristic, it will not be notified.

If the characteristic does not support notifications, an error is returned.

pub fn should_indicate<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, ) -> bool

Check if indications should be sent to connection for this characteristic.

pub async fn indicate<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, value: &T, store: bool, ) -> Result<(), Error>

Send an indication to connection with a new value for the characteristic.

If store is true, the new value will be written to the table before sending the indication.

If the provided connection has not subscribed for this characteristic, it will not be sent an indication.

If the characteristic does not support indications, an error is returned.

Blocks until the peer’s HandleValueConfirmation is received, for up to 30 seconds (BT Core Spec Vol 3, Part F, Section 3.3.3 ATT transaction timeout). On timeout the connection is closed and Error::Timeout is returned. Concurrent calls on the same connection are serialized; callers do not need to coordinate. Returns Error::Disconnected if the connection is dropped while waiting.

pub async fn indicate_raw<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, value: &[u8], store: bool, ) -> Result<(), Error>

Send an indication to connection with a new value for the characteristic.

If store is true, the new value will be written to the table before sending the indication.

If the provided connection has not subscribed for this characteristic, it will not be sent an indication.

If the characteristic does not support indications, an error is returned.

Blocks until the peer’s HandleValueConfirmation is received, for up to 30 seconds (BT Core Spec Vol 3, Part F, Section 3.3.3 ATT transaction timeout). On timeout the connection is closed and Error::Timeout is returned. Concurrent calls on the same connection are serialized; callers do not need to coordinate. Returns Error::Disconnected if the connection is dropped while waiting.

pub fn set<M: RawMutex, P: PacketPool, const AT: usize, const CN: usize>( &self, server: &AttributeServer<'_, M, P, AT, CN>, value: &T, ) -> Result<(), Error>

Set the value of the characteristic in the provided attribute server.

pub fn set_ro<'a, M: RawMutex, P: PacketPool, const AT: usize, const CN: usize>( &self, server: &AttributeServer<'a, M, P, AT, CN>, value: &'a T, ) -> Result<(), Error>

Set the value of the characteristic in the provided attribute server.

pub fn get<M: RawMutex, P: PacketPool, const AT: usize, const CN: usize>( &self, server: &AttributeServer<'_, M, P, AT, CN>, ) -> Result<T, Error>

where T: FromGatt,

Read the value of the characteristic.

If the characteristic for the handle cannot be found, an error is returned.

pub fn with_raw_value<M: RawMutex, P: PacketPool, R, const AT: usize, const CN: usize>( &self, server: &AttributeServer<'_, M, P, AT, CN>, f: impl FnOnce(&[u8]) -> R, ) -> Option<R>

Access the raw byte value of the characteristic.

pub fn cccd_handle(&self) -> Option<CharacteristicPropertiesHandle>

Returns the attribute handle for the characteristic’s client characteristic configuration descriptor (if available)

pub fn to_raw(self) -> Characteristic<[u8]>

Convert this characteristic’s type to raw bytes

Trait Implementations

impl<T: AsGatt + ?Sized> AttributeHandle for Characteristic<T>

type Value = T

The data type which the attribute contains

fn handle(&self) -> u16

Returns the attribute’s handle

impl<T: Clone + AsGatt + ?Sized> Clone for Characteristic<T>

fn clone(&self) -> Characteristic<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsGatt + ?Sized> Debug for Characteristic<T>

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

Formats the value using the given formatter.

impl<T: AsGatt + ?Sized> Format for Characteristic<T>

where Option<u16>: Format, CharacteristicProps: Format, Uuid: Format, PhantomData<T>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<T: PartialEq + AsGatt + ?Sized> PartialEq for Characteristic<T>

fn eq(&self, other: &Characteristic<T>) -> 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<T: Copy + AsGatt + ?Sized> Copy for Characteristic<T>

impl<T: AsGatt + ?Sized> StructuralPartialEq for Characteristic<T>