Struct ConnectionEpisode 

pub struct ConnectionEpisode {
    pub external_id: String,
    pub provider: String,
    pub peer: Option<PeerId>,
    pub opened_at: String,
    pub last_activity_seconds_ago: u64,
    pub attachments: u32,
    pub state: ConnectionEpisodeState,
    pub repository: String,
}

One episode: what the client calls itself, which connection holds it now, and what the repository did about it.

use majordomus_cli::episodes::{ConnectionEpisode, EpisodeBoard};
use majordomus_cli::peers::{PeerBoard, Transport};
let peer = PeerBoard::new().attach(Transport::Http);
let (episode, _) = EpisodeBoard::new().attach(&peer, "conv-42", "generic");
let episode: ConnectionEpisode = episode;
assert_eq!((episode.external_id.as_str(), episode.provider.as_str()), ("conv-42", "generic"));
assert_eq!(episode.peer.as_ref(), Some(&peer));
// never empty: a board with no repository behind it says so
assert!(episode.repository.contains("without a driver"));

Fields

external_id: String

The client’s own durable name for this piece of work, and the key everything here is addressed by. Never a peer id: see the module documentation.

provider: String

The provider id this episode is recorded under, as share/providers.yaml names one.

peer: Option<PeerId>

The connection holding it, when one does. None while detached — which is a state an episode is supposed to reach and come back from, not a fault.

opened_at: String

When it was first opened, RFC 3339, UTC. Unchanged by a re-attach: the episode is the work, and the work did not restart because a socket did.

last_activity_seconds_ago: u64

Seconds since the client last spoke on it, through any connection.

attachments: u32

How many times a connection has taken it over, the first attach included.

state: ConnectionEpisodeState

Open, or detached and waiting for its client.

repository: String

What the repository’s own episode command reported, verbatim — the record it opened, or the reason it could not. Never interpreted here, and never empty: a subsystem that silently does nothing is the failure mode this field exists to make visible.

Trait Implementations

impl Clone for ConnectionEpisode

fn clone(&self) -> ConnectionEpisode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionEpisode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConnectionEpisode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConnectionEpisode

impl JsonSchema for ConnectionEpisode

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 PartialEq for ConnectionEpisode

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

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 ConnectionEpisode