Struct Attached 

pub struct Attached {
    pub episode: ConnectionEpisode,
    pub resumed: bool,
    pub reattach_grace_seconds: u64,
}

The answer of episodes.attach: the episode the connection now holds, whether it was resumed rather than opened, and how long it outlives a lost connection.

use majordomus_cli::capability::builtin::episodes::Attached;
let schema = serde_json::to_value(schemars::schema_for!(Attached)).unwrap();
for field in ["episode", "resumed", "reattach_grace_seconds"] {
    assert!(schema["required"].as_array().unwrap().iter().any(|f| f == field), "{field}");
}

Fields

episode: ConnectionEpisode

The episode this connection now holds.

resumed: bool

Whether an episode already under this identity was resumed rather than a new one opened. True after a reconnect, a client restart or a crash, and the field a caller checks to know whether it is continuing something.

reattach_grace_seconds: u64

How long this episode survives its connection before the reaper closes it, in seconds. Stated rather than left to be discovered: a client that knows the grace can decide whether reconnecting is worth it.

Trait Implementations

impl Debug for Attached

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Attached

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Attached

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 Attached

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

where __S: Serializer,

Serialize this value into the given Serde serializer.