Skip to main content

CooperationStatus

Struct CooperationStatus 

Source
pub struct CooperationStatus {
Show 16 fields pub active: bool, pub reason: Option<String>, pub runtime: Option<String>, pub stream: Option<StreamId>, pub repository: Option<MeshRepositoryIdentity>, pub protocol: (u32, u32), pub features: Vec<String>, pub heartbeat_seconds: u64, pub expiry_seconds: u64, pub endpoints: Vec<String>, pub seeds: Vec<String>, pub peers: Vec<PeerView>, pub refused: Vec<RefusedView>, pub counters: CooperationCounters, pub journal: JournalTallies, pub started_at: Option<String>,
}
Expand description

The whole cooperation runtime, as every surface reports it: the command line, the HTTP surface and MCP all render this one value, so that a person and an agent asking the same question of the same runtime are never told different things.

It answers in one reading the three questions a mesh raises — is this runtime cooperating at all, what does it speak, and who is it linked to — and it stays answerable when the answer is no: an inactive runtime still reports its protocol range and the reason, rather than an absence the caller has to interpret.

use majordomus_cli::mesh::cooperation::CooperationStatus;

let running: CooperationStatus = cooperation.status();
assert_eq!(running.runtime.as_deref(), Some(cooperation.runtime_key()));
assert!(running.peers.is_empty(), "nothing is dialed until something dials");

// and where there is no runtime at all, the same shape says why
let none = CooperationStatus::inactive("the mesh declaration is disabled");
assert_eq!(none.protocol, running.protocol, "still answerable about what it speaks");

Fields§

§active: bool

Whether cooperation runs in this process.

§reason: Option<String>

Why not, when it does not.

§runtime: Option<String>

This runtime, <node>-<runtime>.

§stream: Option<StreamId>

This runtime’s current stream.

§repository: Option<MeshRepositoryIdentity>

The repository identity links are matched on.

§protocol: (u32, u32)

The link protocol range spoken.

§features: Vec<String>

The link features carried.

§heartbeat_seconds: u64

Seconds between heartbeats.

§expiry_seconds: u64

Seconds of silence before expiry.

§endpoints: Vec<String>

Where this runtime answers.

§seeds: Vec<String>

The declared seeds.

§peers: Vec<PeerView>

Every linked peer, by runtime key.

§refused: Vec<RefusedView>

Candidates refused, by endpoint.

§counters: CooperationCounters

Counters.

§journal: JournalTallies

The journal’s tallies.

§started_at: Option<String>

When cooperation started, RFC 3339.

Implementations§

Source§

impl CooperationStatus

Source

pub fn inactive(reason: &str) -> Self

The status of a runtime where cooperation is not running, and why.

The protocol range and the features are still filled in, because what this executable would speak is knowable without a runtime and a person comparing two machines needs it precisely when one of them is not cooperating.

use majordomus_cli::mesh::cooperation::CooperationStatus;

let status = CooperationStatus::inactive("no mesh declaration in this repository");
assert!(!status.active);
assert!(status.reason.unwrap().contains("no mesh declaration"), "never a bare false");
assert!(!status.features.is_empty(), "what it would speak is known without a runtime");

Trait Implementations§

Source§

impl Clone for CooperationStatus

Source§

fn clone(&self) -> CooperationStatus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CooperationStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CooperationStatus

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for CooperationStatus

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl Serialize for CooperationStatus

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more