Enum CloseOutcome 

pub enum CloseOutcome {
    Closed,
    AlreadyClosed,
    AlreadyClosing,
    Refused,
}

What a close did: wrote the record, found one already standing, found another caller inside the window, or was refused by the machine.

use majordomus_cli::session::CloseOutcome;
// a duplicate close is a diagnosable outcome, not an error: a provider's second end
// event is that provider's normal behaviour
assert!(CloseOutcome::Closed.wrote());
assert!(!CloseOutcome::AlreadyClosed.wrote());

Variants

Closed

This caller took the claim and published the record. Exactly one caller per episode ever sees this.

AlreadyClosed

A record for this episode already stands; this close added none.

AlreadyClosing

Another caller holds the claim at this moment. Nothing was written.

Refused

The episode is not in a state the machine lets it leave. Nothing was written.

Implementations

impl CloseOutcome

pub fn wrote(self) -> bool

Did this call publish the record?

use majordomus_cli::session::CloseOutcome;
assert!(CloseOutcome::Closed.wrote());
assert!(!CloseOutcome::AlreadyClosed.wrote());

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

The word as serialised, which is what a caller prints and what a projection of a close carries.

use majordomus_cli::session::CloseOutcome;
assert_eq!(CloseOutcome::AlreadyClosing.as_str(), "already_closing");

Trait Implementations

impl Clone for CloseOutcome

fn clone(&self) -> CloseOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CloseOutcome

impl Debug for CloseOutcome

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CloseOutcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CloseOutcome

impl JsonSchema for CloseOutcome

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 CloseOutcome

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

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

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

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 CloseOutcome