Enum EpisodeState 

pub enum EpisodeState {
    Opening,
    Open,
    Detached,
    Closed,
}

Where an episode is: minted, open, detached from the connection that held it, or closed into the immutable record.

use majordomus_cli::session::EpisodeState;

assert!(EpisodeState::Open.may_move_to(EpisodeState::Closed));
assert!(!EpisodeState::Closed.may_move_to(EpisodeState::Open), "a record is immutable");
assert!(EpisodeState::Open.may_move_to(EpisodeState::Open), "a resume is not a move");
assert!(EpisodeState::Closed.is_final());

Variants

Opening

An identity has been minted and nothing durable has been written yet. It exists so that a crash between minting an id and writing the open record is a state the model can name rather than an episode that never happened.

Open

The open record stands. The worker is here, or was recently.

Detached

The connection that held the episode went away, and the episode did not. A dropped socket is the most ordinary thing that happens to a session; an episode that closed itself on every disconnect would lose the work of every worker whose network hiccuped. It is still resumable, and it is still recoverable if nobody resumes it.

Closed

The immutable record has been published. Terminal, and terminal is the point: the four records of s-20260909152316-024f all exist because nothing in the previous representation could say this.

Implementations

impl EpisodeState

pub const ALL: [EpisodeState; 4]

Every state, in the order a reader meets them. The projection of the machine is built from this rather than from a list written a second time somewhere else.

pub fn may_move_to(self, target: EpisodeState) -> bool

May an episode in this state move to target?

The whole transition table, and the only copy of it. Note what the signature does not take: there is no task, no outcome and no policy. A transition of an episode is a fact about the episode.

use majordomus_cli::session::EpisodeState::*;

assert!(Opening.may_move_to(Open));
assert!(Open.may_move_to(Detached) && Detached.may_move_to(Open));
assert!(Open.may_move_to(Closed) && Detached.may_move_to(Closed));

// an episode that never opened cannot be closed into a record of what it did
assert!(!Opening.may_move_to(Closed));
// and nothing leaves the terminal state
for target in [Opening, Open, Detached, Closed] {
    assert!(!Closed.may_move_to(target));
}

pub fn is_final(self) -> bool

Is this a state an episode never leaves? True of closed alone, which is what a store asks before it writes and a reader asks before it waits for a change.

use majordomus_cli::session::EpisodeState;
assert!(EpisodeState::Closed.is_final());
assert!(!EpisodeState::Detached.is_final(), "a detached episode can still be resumed");

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

The word as serialised, which is the word every projection of the machine carries and the word a person reads in session status.

use majordomus_cli::session::EpisodeState;
assert_eq!(EpisodeState::Detached.as_str(), "detached");
assert_eq!(EpisodeState::Closed.as_str(), "closed");

Trait Implementations

impl Clone for EpisodeState

fn clone(&self) -> EpisodeState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EpisodeState

impl Debug for EpisodeState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EpisodeState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EpisodeState

impl Hash for EpisodeState

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 EpisodeState

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

The name of the generated JSON Schema.

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

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

fn json_schema(generator: &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.

impl Ord for EpisodeState

fn cmp(&self, other: &EpisodeState) -> 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.

impl PartialEq for EpisodeState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for EpisodeState

fn partial_cmp(&self, other: &EpisodeState) -> 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 EpisodeState

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 EpisodeState