Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub service: Service,
    pub subsystem: u32,
    pub command: u32,
    pub args: Vec<u8>,
    /* private fields */
}
Expand description

One protocol message, decoded.

Fields§

§service: Service§subsystem: u32§command: u32§args: Vec<u8>

Everything between the command word and the CRC. Ordinary responses include their leading status word; cmd::CHANGED does not.

Implementations§

Source§

impl Message

Source

pub fn new( service: Service, subsystem: u32, command: u32, args: Vec<u8>, ) -> Self

A request, to send to the device.

Source

pub fn is_response(&self) -> bool

Whether this message was decoded as a device response.

Direction, not parity. Parity invites the guess and does not support it: the “select in instrument” command is 0x2f (odd) with response 0x30 (even), exactly inverting it. The response == request + 1 rule does hold — only the parity of the request does not. Getting this backwards silently misaligns Self::payload by four bytes and hides device errors, so it is recorded at decode time by the side that knows.

Source

pub fn status(&self) -> Option<u32>

The status word an ordinary response leads with. Some(0) is success.

Source

pub fn payload(&self) -> &[u8]

Arguments with an ordinary response’s status stripped. Notifications are unchanged.

Source

pub fn encode(&self) -> Vec<u8>

Source

pub fn decode_response(buf: &[u8]) -> Result<Self>

Decode bytes received from the device.

Source

pub fn decode_probe(buf: &[u8]) -> Result<Self>

Decode an exploratory reply without requiring the ordinary status word. A short frame is an observation, not a typed operation failure.

Source

pub fn decode(buf: &[u8]) -> Result<Self>

Decode bytes without asserting a direction; treated as a request. Prefer Self::decode_response for anything read off the wire.

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Message

Source§

impl PartialEq for Message

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.