Module buttplug::core::messages

Representations of low level Buttplug Protocol messages

The messages module contains the core communication types for the Buttplug protocol. There are structs for each message type, sometimes with multiple versions of the same message relating to different spec versions. There are also enum types that are used to classify messages into categories, for instance, messages that only should be sent by a client or server.

Modules

serializer

Structs

BatteryLevelCmd
BatteryLevelReading
DeviceAdded
DeviceAddedV0
DeviceAddedV1
DeviceList
DeviceListV0
DeviceListV1
DeviceMessageInfo
DeviceRemoved
Error	Represents the Buttplug Protocol Error message, as documented in the Buttplug Protocol Spec.
FleshlightLaunchFW12Cmd
KiirooCmd
LinearCmd
Log
LovenseCmd
MessageAttributes
Ok	Represents the Buttplug Protocol Ok message, as documented in the Buttplug Protocol Spec.
Ping
RSSILevelCmd
RSSILevelReading
RawReadCmd
RawReading
RawSubscribeCmd
RawUnsubscribeCmd
RawWriteCmd
RequestDeviceList
RequestLog
RequestServerInfo
RotateCmd
RotationSubcommand
ScanningFinished
ServerInfo
ServerInfoV0
SingleMotorVibrateCmd
StartScanning
StopAllDevices
StopDeviceCmd
StopScanning
Test
VectorSubcommand
VibrateCmd
VibrateSubcommand
VorzeA10CycloneCmd

Enums

ButtplugClientMessage	Represents all possible messages a ButtplugClient can send to a ButtplugServer.
ButtplugDeviceCommandMessageUnion	Represents all possible device command message types.
ButtplugDeviceManagerMessageUnion	Represents messages that should go to the DeviceManager of a ButtplugServer
ButtplugDeviceMessageType	Used in MessageAttributes for denoting message capabilties.
ButtplugMessageSpecVersion	Enum of possible Buttplug Message Spec versions.
ButtplugServerMessage	Represents all possible messages a ButtplugServer can send to a ButtplugClient.
ButtplugSpecV2ClientMessage	Represents all client-to-server messages in v2 of the Buttplug Spec
ButtplugSpecV2ServerMessage	Represents all server-to-client messages in v2 of the Buttplug Spec
ErrorCode	Error codes pertaining to error classes that can be represented in the Buttplug Error message.
LogLevel

Constants

BUTTPLUG_CURRENT_MESSAGE_SPEC_VERSION	The current latest version of the spec implemented by the library.
BUTTPLUG_SERVER_EVENT_ID	Message Id for events sent from the server, which are not in response to a client request.

Traits

ButtplugClientMessageType
ButtplugDeviceMessage	Adds device index handling to the ButtplugMessage trait.
ButtplugMessage	Base trait for all Buttplug Protocol Message Structs. Handles management of message ids, as well as implementing conveinence functions for converting between message structs and various message enums, serialization, etc...
ButtplugServerMessageType

Type Definitions

ButtplugCurrentSpecClientMessage	Type alias for the latest version of client-to-server messages.
ButtplugCurrentSpecServerMessage	Type alias for the latest version of server-to-client messages.
MessageAttributesMap