Struct FaultId 

pub struct FaultId(/* private fields */);

A fault identifier in kebab-case, e.g. paper-out.

The IDs from PRD section 10 are associated constants. Plugins may define their own IDs; any lowercase kebab-case string is accepted.

use hardless_core::FaultId;
let id: FaultId = "paper-out".parse().unwrap();
assert_eq!(id, FaultId::PAPER_OUT);
assert!("Paper_Out".parse::<FaultId>().is_err());

Implementations

impl FaultId

pub const PAPER_OUT: FaultId

Printers: prints rejected; status reports paper end.

pub const PAPER_NEAR_END: FaultId

Printers: prints succeed; status reports near end.

pub const COVER_OPEN: FaultId

Printers: prints rejected; status reports cover open.

pub const OFFLINE: FaultId

Printers: serial/USB disconnect; HTTP refuses connections.

pub const DISCONNECT_MID_WRITE: FaultId

Serial and USB printers: disconnect after afterBytes bytes of the next job.

pub const SLOW_WRITE: FaultId

Serial and USB printers: delay each chunk acknowledgement by msPerChunk.

pub const BAUD_MISMATCH: FaultId

Serial printers: received bytes are scrambled.

pub const GARBLED: FaultId

All printers: random byte corruption at rate.

pub const TIMEOUT: FaultId

HTTP printers: response delayed past the request’s timeout.

pub const CORS_BLOCKED: FaultId

HTTP printers: CORS headers omitted.

pub const STALL: FaultId

USB printers: transferOut returns status: "stall".

pub const INTERFACE_BUSY: FaultId

USB printers: claimInterface rejects.

pub const PICKER_CANCEL: FaultId

Serial, USB and NFC: the next request* call behaves as a user cancel.

pub const PERMISSION_DENIED: FaultId

NFC: scan() rejects with NotAllowedError.

pub const READ_ERROR: FaultId

NFC: the next tap fires readingerror.

pub const JAMMED: FaultId

Drawer: kick received, drawer stays closed.

pub const NOT_CONNECTED: FaultId

Drawer: kick ignored; status shows no drawer.

pub const DOUBLE_SCAN: FaultId

Scanner: each scan is sent twice, gapMs apart.

pub const PARTIAL_SCAN: FaultId

Scanner: terminator dropped.

impl FaultId

pub fn as_str(&self) -> &str

The ID as a string slice.

pub fn lookup(id: &str) -> Option<&'static FaultSpec>

The catalogue entry for this ID, if it is one of the built-in faults.

use hardless_core::FaultId;
assert_eq!(FaultId::lookup("garbled").unwrap().options[0].name, "rate");
assert!(FaultId::lookup("made-up").is_none());

Trait Implementations

impl Clone for FaultId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FaultId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FaultId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FaultId

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

Formats the value using the given formatter.

impl Eq for FaultId

impl From<FaultId> for String

fn from(id: FaultId) -> String

Converts to this type from the input type.

impl FromStr for FaultId

type Err = InvalidId

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FaultId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for FaultId

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for FaultId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FaultId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FaultId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FaultId

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 FaultId

impl TryFrom<String> for FaultId

type Error = InvalidId

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.