Struct btleplug::api::Characteristic

pub struct Characteristic {
    pub start_handle: u16,
    pub end_handle: u16,
    pub value_handle: u16,
    pub uuid: UUID,
    pub properties: CharPropFlags,
}

A Bluetooth characteristic. Characteristics are the main way you will interact with other bluetooth devices. Characteristics are identified by a UUID which may be standardized (like 0x2803, which identifies a characteristic for reading heart rate measurements) but more often are specific to a particular device. The standard set of characteristics can be found here.

A characteristic may be interacted with in various ways depending on its properties. You may be able to write to it, read from it, set its notify or indicate status, or send a command to it.

Fields

start_handle: u16

The start of the handle range that contains this characteristic. Only valid on Linux, will be 0 on all other platforms.

end_handle: u16

The end of the handle range that contains this characteristic. Only valid on Linux, will be 0 on all other platforms.

value_handle: u16

The value handle of the characteristic. Only valid on Linux, will be 0 on all other platforms.

uuid: UUID

The UUID for this characteristic. This uniquely identifies its behavior.

properties: CharPropFlags

The set of properties for this characteristic, which indicate what functionality it supports. If you attempt an operation that is not supported by the characteristics (for example setting notify on one without the NOTIFY flag), that operation will fail.

Trait Implementations

impl Clone for Characteristic

fn clone(&self) -> Characteristic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Characteristic

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

Formats the value using the given formatter.

impl Display for Characteristic

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

Formats the value using the given formatter.

impl Eq for Characteristic

impl Ord for Characteristic

fn cmp(&self, other: &Characteristic) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Characteristic> for Characteristic

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Characteristic> for Characteristic

fn partial_cmp(&self, other: &Characteristic) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Characteristic) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Characteristic) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Characteristic) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Characteristic) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Characteristic

impl StructuralPartialEq for Characteristic