Struct Characteristic

pub struct Characteristic<T: AsGatt> {
    pub cccd_handle: Option<u16>,
    pub handle: u16,
    /* 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

Implementations

impl<T: FromGatt> Characteristic<T>

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

Write a value to a characteristic, and notify a connection with the new value of the characteristic.

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 indicate<P: PacketPool>( &self, connection: &GattConnection<'_, '_, P>, value: &T, ) -> Result<(), Error>

Write a value to a characteristic, and indicate a connection with the new value of the characteristic.

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.

This function does not block for the confirmation to the indication message, if the client sends a confirmation this will be seen on the GattConnection as a crate::att::AttClient::Confirmation event.

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

Read the value of the characteristic.

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

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

Returns the attribute handle for the characteristic’s properties (if available)

Trait Implementations

impl<T: AsGatt> 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> Clone for Characteristic<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: AsGatt> Format for Characteristic<T>

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

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

Writes the defmt representation of self to fmt.

impl<T: PartialEq + AsGatt> 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> Copy for Characteristic<T>

impl<T: AsGatt> StructuralPartialEq for Characteristic<T>