Skip to main content

Step

Enum Step 

Source
pub enum Step {
    Scan {
        device: DeviceId,
        code: String,
        terminator: Option<Terminator>,
        delay_ms: Option<u64>,
    },
    Tap {
        device: DeviceId,
        uid: String,
        records: Option<Vec<NdefRecord>>,
    },
    Wait {
        ms: u64,
    },
    SetFault {
        device: DeviceId,
        fault: FaultId,
        options: FaultOptions,
    },
    ClearFault {
        device: DeviceId,
        fault: FaultId,
    },
    Expect {
        device: DeviceId,
        state: Option<Value>,
        receipt_contains: Option<String>,
        jobs: Option<u32>,
        within_ms: Option<u64>,
    },
}
Expand description

One scenario step.

Variants§

§

Scan

Scan a barcode on a keyboard-wedge scanner.

Fields

§device: DeviceId

The scanner.

§code: String

The barcode.

§terminator: Option<Terminator>

Overrides the scanner’s terminator.

§delay_ms: Option<u64>

Overrides the scanner’s inter-key delay.

§

Tap

Tap an NFC card.

Fields

§device: DeviceId

The NFC reader.

§uid: String

Card UID as hex.

§records: Option<Vec<NdefRecord>>

NDEF records; without them the reader uses what it remembers of the card.

§

Wait

Wait.

Fields

§ms: u64

Milliseconds to wait.

§

SetFault

Turn a fault on.

Fields

§device: DeviceId

The device.

§fault: FaultId

The fault.

§options: FaultOptions

Its options.

§

ClearFault

Turn a fault off.

Fields

§device: DeviceId

The device.

§fault: FaultId

The fault.

§

Expect

Check a device. Every given check must hold; with withinMs, they may become true within that time (e.g. a receipt the app prints in response to a scan).

Fields

§device: DeviceId

The device.

§state: Option<Value>

Fields the device state must have (a subset match: nested objects compare by the keys given).

§receipt_contains: Option<String>

Text the latest job must contain.

§jobs: Option<u32>

How many jobs the device must hold.

§within_ms: Option<u64>

How long the checks may take to become true, in milliseconds (default 0).

Implementations§

Source§

impl Step

Source

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

The step’s type, e.g. "setFault".

Trait Implementations§

Source§

impl Clone for Step

Source§

fn clone(&self) -> Self

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 Step

Source§

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

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

impl<'de> Deserialize<'de> for Step

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Step

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Step

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Step

Auto Trait Implementations§

§

impl Freeze for Step

§

impl RefUnwindSafe for Step

§

impl Send for Step

§

impl Sync for Step

§

impl Unpin for Step

§

impl UnsafeUnpin for Step

§

impl UnwindSafe for Step

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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.