Skip to main content

CooperationConfig

Struct CooperationConfig 

Source
pub struct CooperationConfig {
    pub enabled: bool,
    pub heartbeat_seconds: u64,
    pub expiry_seconds: u64,
    pub seeds: Vec<String>,
    pub repository: Option<String>,
}
Expand description

Cooperation settings: whether this runtime links to the trusted runtimes of its repository, how often it proves it is alive, when a silent runtime counts as gone, and which endpoints to dial when discovery cannot find them.

Every field has a default that is safe on its own, so a declaration that says nothing about cooperation still behaves as intended: links are on, but a link needs a trusted peer of the same repository, and under the default trust policy there is none until a person lists a key.

use majordomus_cli::mesh::config::{CooperationConfig, DEFAULT_EXPIRY, DEFAULT_HEARTBEAT};

let default = CooperationConfig::default();
assert!(default.enabled && default.seeds.is_empty() && default.repository.is_none());
assert!(
    default.expiry_seconds >= 3 * default.heartbeat_seconds,
    "one lost round must never expire a runtime",
);

// and what a declaration leaves out, it gets
let stated: CooperationConfig =
    serde_json::from_value(serde_json::json!({ "seeds": ["http://10.0.0.2:8742"] })).unwrap();
assert_eq!(stated.seeds, ["http://10.0.0.2:8742"]);
assert_eq!(stated.heartbeat_seconds, DEFAULT_HEARTBEAT);
assert_eq!(stated.expiry_seconds, DEFAULT_EXPIRY);

Fields§

§enabled: bool

Whether links open at all. On by default once the mesh is enabled: a link needs a trusted peer of the same repository, so under the default deny_unknown policy with an empty allowlist nothing links until a person lists a key.

§heartbeat_seconds: u64

Seconds between heartbeats: one beat and one sync per link per interval.

§expiry_seconds: u64

Seconds of silence after which a runtime is expired: its sessions end and its claims stop excluding. At least three heartbeats, so one lost round never expires anyone.

§seeds: Vec<String>

Endpoints (http://host:port) to dial whether or not discovery heard them: a static fleet, or a segment neither multicast nor a rendezvous reaches.

§repository: Option<String>

The repository’s mesh identity, declared rather than derived from its root commits: what a shallow clone needs, and what separates two repositories sharing a history.

Implementations§

Source§

impl CooperationConfig

Source

pub fn validate(&self) -> Result<(), String>

Refuse the settings that cannot work: a zero heartbeat, an expiry under three heartbeats (one lost round would expire a live runtime), a seed that is not http://host:port, an empty or oversized declared repository.

use majordomus_cli::mesh::config::CooperationConfig;
assert!(CooperationConfig::default().validate().is_ok());
let flapping = CooperationConfig { heartbeat_seconds: 10, expiry_seconds: 15, ..Default::default() };
assert!(flapping.validate().is_err());

Trait Implementations§

Source§

impl Clone for CooperationConfig

Source§

fn clone(&self) -> CooperationConfig

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 CooperationConfig

Source§

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

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

impl Default for CooperationConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CooperationConfig

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 CooperationConfig

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 CooperationConfig

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