Struct buttplug::core::messages::Error

pub struct Error {
    pub error_code: ErrorCode,
    pub error_message: String,
    // some fields omitted
}

Represents the Buttplug Protocol Error message, as documented in the Buttplug Protocol Spec.

Fields

error_code: ErrorCode

Specifies the class of the error.

error_message: String

Description of the error.

Implementations

impl Error

pub fn new(error_code: ErrorCode, error_message: &str) -> Self

Creates a new error object.

Trait Implementations

impl ButtplugMessage for Error

fn get_id(&self) -> u32

Returns the id number of the message

fn set_id(&mut self, id: u32)

Sets the id number of the message.

fn is_server_event(&self) -> bool

True if the message is an event (message id of 0) from the server.

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<ButtplugError> for Error

fn from(error: ButtplugError) -> Self

Converts a ButtplugError object into a Buttplug Protocol Error message.

impl From<ButtplugServerError> for Error

fn from(error: ButtplugServerError) -> Self

Converts a ButtplugError object into a Buttplug Protocol Error message.

impl From<Error> for ButtplugServerError

fn from(error: Error) -> Self

Turns a Buttplug Protocol Error Message super::messages::Error into a ButtplugError type.

impl From<Error> for ButtplugError

fn from(error: Error) -> Self

Turns a Buttplug Protocol Error Message super::messages::Error into a ButtplugError type.

impl From<Error> for ButtplugServerMessage

fn from(msg: Error) -> ButtplugServerMessage

Performs the conversion.

impl From<Error> for ButtplugSpecV2ServerMessage

fn from(msg: Error) -> ButtplugSpecV2ServerMessage

Performs the conversion.

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl Serialize for Error

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Error