Skip to main content

Operation

Enum Operation 

Source
pub enum Operation {
Show 13 variants SendVariable, RequireVariable, Invoke, GetVersion, Start, EndTransaction, Acknowledge, Query, Return, Empty, Data, Await, Error,
}
Expand description

Defines the set of operations supported by the PK Command protocol.

Variants§

§

SendVariable

To set a variable’s value on the device.

5-character name: SENDV

§

RequireVariable

To get a variable’s value from the device.

5-character name: REQUV

§

Invoke

To invoke a method on the device.

5-character name: INVOK

§

GetVersion

To get the version of the PK Command processor on the device.

5-character name: PKVER

§

Start

To indicate the start of a transaction chain.

This is used internally by the poll method to manage transaction stages and usually should not be used directly.

5-character name: START

§

EndTransaction

To indicate the end of a transaction chain.

This is used internally by the poll method to manage transaction stages and usually should not be used directly.

5-character name: ENDTR

§

Acknowledge

To acknowledge the receipt of a command.

This is used internally by the state machine to manage acknowledgment status and usually should not be used directly.

5-character name: ACKNO

§

Query

To request the outbound data from the device.

This is used internally by the state machine to manage transaction stages and usually should not be used directly.

5-character name: QUERY

§

Return

To return the response data from the device to the host.

This is used internally by the state machine to manage transaction stages and usually should not be used directly.

5-character name: RTURN

§

Empty

To indicate that the current transaction phase has no data.

This is used internally by the state machine to manage transaction stages and usually should not be used directly.

5-character name: EMPTY

§

Data

To send a chunk of data.

This is used internally by the state machine to manage transaction stages and usually should not be used directly.

5-character name: SDATA

§

Await

To indicate that the device is still processing and the transaction should be kept alive.

This is used internally by the state machine to manage transaction stages and usually should not be used directly.

5-character name: AWAIT

§

Error

To indicate an error occurred during transaction processing.

This is used internally by the state machine to manage error handling and usually should not be used directly.

5-character name: ERROR

Implementations§

Source§

impl Operation

Source

pub fn to_name(&self) -> &'static str

Returns the 5-character string representation of the operation.

Source

pub fn from_name(name: &str) -> Option<Operation>

Creates an Operation from its 5-character string representation.

Source

pub fn is_root(&self) -> bool

Checks if the operation is a “root operation” that can initiate a transaction chain.

Trait Implementations§

Source§

impl Clone for Operation

Source§

fn clone(&self) -> Operation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Operation

Source§

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

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

impl PartialEq for Operation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Operation

Source§

impl Eq for Operation

Source§

impl StructuralPartialEq for Operation

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.