Struct buttplug::client::device::ButtplugClientDevice

pub struct ButtplugClientDevice {
    pub name: String,
    pub allowed_messages: MessageAttributesMap,
    // some fields omitted
}

Fields

name: String

allowed_messages: MessageAttributesMap

Implementations

impl ButtplugClientDevice

pub async fn wait_for_event<'_>(
    &'_ mut self
) -> Result<ButtplugClientDeviceEvent, ButtplugClientError>

Produces a future that will wait for a set of events from the internal loop. Returns once any number of events is received.

This should be called whenever the client isn't doing anything otherwise, so we can respond to unexpected updates from the server, such as devices connections/disconnections, log messages, etc... This is basically what event handlers in C# and JS would deal with, but we're in Rust so this requires us to be slightly more explicit.

pub async fn vibrate<'_>(
    &'_ mut self,
    speed_cmd: VibrateCommand
) -> Result<(), ButtplugClientError>

pub async fn linear<'_>(
    &'_ mut self,
    linear_cmd: LinearCommand
) -> Result<(), ButtplugClientError>

pub async fn rotate<'_>(
    &'_ mut self,
    rotate_cmd: RotateCommand
) -> Result<(), ButtplugClientError>

pub async fn stop<'_>(&'_ mut self) -> Result<(), ButtplugClientError>

Trait Implementations

impl<'_> From<(&'_ DeviceMessageInfo, Sender<(ButtplugSpecV2InMessage, Arc<Mutex<ButtplugFutureState<ButtplugSpecV2OutMessage>>>)>, Receiver<ButtplugClientDeviceEvent>)> for ButtplugClientDevice

fn from(
    msg_sender_tuple: (&DeviceMessageInfo, Sender<ButtplugMessageFuturePair>, Receiver<ButtplugClientDeviceEvent>)
) -> Self

Performs the conversion.

impl Send for ButtplugClientDevice

impl Sync for ButtplugClientDevice