Enum buttplug::core::message::Endpoint

pub enum Endpoint {
    Command,
    Firmware,
    Rx,
    RxAccel,
    RxBLEBattery,
    RxBLEModel,
    RxPressure,
    RxTouch,
    Tx,
    TxMode,
    TxShock,
    TxVibrate,
    TxVendorControl,
    Whitelist,
    Generic0,
    Generic1,
    Generic2,
    Generic3,
    Generic4,
    Generic5,
    Generic6,
    Generic7,
    Generic8,
    Generic9,
    Generic10,
    Generic11,
    Generic12,
    Generic13,
    Generic14,
    Generic15,
    Generic16,
    Generic17,
    Generic18,
    Generic19,
    Generic20,
    Generic21,
    Generic22,
    Generic23,
    Generic24,
    Generic25,
    Generic26,
    Generic27,
    Generic28,
    Generic29,
    Generic30,
    Generic31,
}

Endpoint names for device communication.

Endpoints denote different contextual communication targets on a device. For instance, for a device that uses UART style communication (serial, a lot of Bluetooth LE devices, etc…) most devices will just have a Tx and Rx endpoint. However, on other devices that can have varying numbers of endpoints and configurations (USB, Bluetooth LE, etc…) we add some names with more context. These names are used in Device Configuration and the Device Configuration File, and are expected to de/serialize to lowercase versions of their names.

Variants

Command

Expect to take commands, when multiple receive endpoints may be available

Firmware

Firmware updates (Buttplug does not update firmware, but some firmware endpoints are used for mode setting)

Rx

Common receive endpoint name

RxAccel

Receive endpoint for accelerometer data

RxBLEBattery

Receive endpoint for battery levels (usually expected to be BLE standard profile)

RxBLEModel

Receive endpoint for BLE model (usually expected to be BLE standard profile)

RxPressure

Receive endpoint for pressure sensors

RxTouch

Receive endpoint for touch sensors

Tx

Common transmit endpoint name

TxMode

Transmit endpoint for hardware mode setting.

TxShock

Transmit endpoint for shock setting (unused)

TxVibrate

Transmit endpoint for vibration setting

TxVendorControl

Transmit endpoint for vendor (proprietary) control

Whitelist

Transmit endpoint for whitelist updating

Generic0

Generic endpoint (available for user configurations)

Generic1

Generic endpoint (available for user configurations)

Generic2

Generic endpoint (available for user configurations)

Generic3

Generic endpoint (available for user configurations)

Generic4

Generic endpoint (available for user configurations)

Generic5

Generic endpoint (available for user configurations)

Generic6

Generic endpoint (available for user configurations)

Generic7

Generic endpoint (available for user configurations)

Generic8

Generic endpoint (available for user configurations)

Generic9

Generic endpoint (available for user configurations)

Generic10

Generic endpoint (available for user configurations)

Generic11

Generic endpoint (available for user configurations)

Generic12

Generic endpoint (available for user configurations)

Generic13

Generic endpoint (available for user configurations)

Generic14

Generic endpoint (available for user configurations)

Generic15

Generic endpoint (available for user configurations)

Generic16

Generic endpoint (available for user configurations)

Generic17

Generic endpoint (available for user configurations)

Generic18

Generic endpoint (available for user configurations)

Generic19

Generic endpoint (available for user configurations)

Generic20

Generic endpoint (available for user configurations)

Generic21

Generic endpoint (available for user configurations)

Generic22

Generic endpoint (available for user configurations)

Generic23

Generic endpoint (available for user configurations)

Generic24

Generic endpoint (available for user configurations)

Generic25

Generic endpoint (available for user configurations)

Generic26

Generic endpoint (available for user configurations)

Generic27

Generic endpoint (available for user configurations)

Generic28

Generic endpoint (available for user configurations)

Generic29

Generic endpoint (available for user configurations)

Generic30

Generic endpoint (available for user configurations)

Generic31

Generic endpoint (available for user configurations)

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Endpoint

fn deserialize<D>(deserializer: D) -> Result<Endpoint, D::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Endpoint

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

Formats the value using the given formatter.

impl FromStr for Endpoint

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Endpoint, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Endpoint

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Endpoint> for Endpoint

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Endpoint

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Endpoint

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Endpoint, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for Endpoint

impl Eq for Endpoint

impl StructuralEq for Endpoint

impl StructuralPartialEq for Endpoint