printobserver-types 0.6.1

Shared domain types for printobserver.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! The state a source reports a printer or a print to be in.
//!
//! Two ports speak it: the printer port's snapshots report it, and the
//! supervisor port's turn situation hands it to the agent. Neither port may
//! depend on the other, so the one vocabulary both read is declared here, and
//! `printobserver-printer-api` re-exports it where its own users name it. The
//! supervision domain's print record carries the same state.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::contract::Sample;

/// The state a source reports a printer or a print to be in.
///
/// The `unknown` arm exists so that a state nobody anticipated is recorded
/// carrying the source's own word for it rather than lost.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
// llmlint: ignore[code_lands_in_the_domain_that_owns_it] suppressions.toml has the reason.
pub enum PrinterState {
    /// Connected and idle.
    Operational,
    /// Printing, but paused.
    Paused,
    /// Printing.
    Printing,
    /// Cancelling a print.
    Cancelling,
    /// In an error state.
    Error,
    /// Not reachable.
    Offline,
    /// A state this vocabulary does not name, in the source's own word for it.
    Unknown(String),
}

impl Sample for PrinterState {
    fn sample_full() -> Self {
        Self::Printing
    }
}