Struct buttplug::client::device::ButtplugClientDevice

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

Client-usable representation of device connected to the corresponding ButtplugServer

ButtplugClientDevice instances are obtained from the ButtplugClient, and allow the user to send commands to a device connected to the server.

Fields

name: String

Name of the device

allowed_messages: MessageAttributesMap

Map of messages the device can take, along with the attributes of those messages.

Implementations

impl ButtplugClientDevice

pub fn event_receiver(
    &self
) -> impl SinkExt<ButtplugClientDeviceEvent, Error = SendError> + Sync + Send

pub fn vibrate(
    &self,
    speed_cmd: VibrateCommand
) -> BoxFuture<'static, Result<(), ButtplugClientError>>

Commands device to vibrate, assuming it has the features to do so.

pub fn linear(
    &self,
    linear_cmd: LinearCommand
) -> BoxFuture<'static, Result<(), ButtplugClientError>>

Commands device to move linearly, assuming it has the features to do so.

pub fn rotate(
    &self,
    rotate_cmd: RotateCommand
) -> BoxFuture<'static, Result<(), ButtplugClientError>>

Commands device to rotate, assuming it has the features to do so.

pub fn stop(&self) -> BoxFuture<'static, Result<(), ButtplugClientError>>

Commands device to stop all movement.

pub fn index(&self) -> u32

Trait Implementations

impl Clone for ButtplugClientDevice

fn clone(&self) -> ButtplugClientDevice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for ButtplugClientDevice

impl<'_> From<(&'_ DeviceMessageInfo, Sender<ButtplugClientRequest>, BroadcastChannel<ButtplugClientDeviceEvent, UnboundedSender<ButtplugClientDeviceEvent>, UnboundedReceiver<ButtplugClientDeviceEvent>>)> for ButtplugClientDevice

fn from(
    msg_sender_tuple: (&DeviceMessageInfo, Sender<ButtplugClientRequest>, BroadcastChannel<ButtplugClientDeviceEvent>)
) -> Self

Performs the conversion.

impl PartialEq<ButtplugClientDevice> for ButtplugClientDevice

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Send for ButtplugClientDevice

impl Sync for ButtplugClientDevice