Struct EpisodeList 

pub struct EpisodeList {
    pub open: usize,
    pub detached: usize,
    pub episodes: Vec<ConnectionEpisode>,
    pub mine: Option<ConnectionEpisode>,
}

The answer of episodes.list: every episode this server holds, counted by state, and the one the caller holds. In memory only — it is the association between live connections and the repository’s records, which stops being true when the process stops.

The two counts partition the list, and mine is left out of the JSON rather than written as null when the caller holds nothing, which is always so over plain HTTP:

use majordomus_cli::capability::builtin::episodes::EpisodeList;
let none = EpisodeList { open: 0, detached: 0, episodes: vec![], mine: None };
let json = serde_json::to_value(&none).unwrap();
assert_eq!(json, serde_json::json!({"open": 0, "detached": 0, "episodes": []}));
let back: EpisodeList = serde_json::from_value(json).unwrap();
assert_eq!(back.open + back.detached, back.episodes.len());

Fields

open: usize

How many are open — held by a connection that is still there.

detached: usize

How many are detached, waiting for a client to come back inside the grace. Not a fault count: this is where a crashed client’s work waits to be resumed.

episodes: Vec<ConnectionEpisode>

Every episode, open and detached, in external-identity order.

mine: Option<ConnectionEpisode>

The episode the calling connection holds, when it holds one.

Trait Implementations

impl Debug for EpisodeList

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EpisodeList

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EpisodeList

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 Serialize for EpisodeList

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

where __S: Serializer,

Serialize this value into the given Serde serializer.