Skip to main content

RepositoryEnvironment

Struct RepositoryEnvironment 

Source
pub struct RepositoryEnvironment {
Show 14 fields pub schema: String, pub generated_at: String, pub resolution: Resolution, pub project: ProjectIdentity, pub repository: RepositoryIdentity, pub vcs: VcsState, pub toolchains: Vec<ToolchainState>, pub layer: LayerSummary, pub workflows: WorkflowCatalogue, pub providers: Vec<ProviderState>, pub services: Vec<ServiceState>, pub reasoning: Option<ReasoningSummary>, pub diagnostics: Vec<Diagnostic>, pub provenance: Vec<FieldSource>,
}
Expand description

The snapshot: what this checkout is, right now.

Every surface that reports any of this renders this value. Collections are in a documented, stable order — kinds and workflows by name, services and providers in the order their canonical source declares them, diagnostics in the order they were found — so that two snapshots of the same repository serialise identically apart from RepositoryEnvironment::generated_at.

Fields§

§schema: String

The contract this document follows, majordomus/repository-environment/v1.

§generated_at: String

When it was taken, RFC 3339 in UTC.

§resolution: Resolution

How completely it was resolved.

§project: ProjectIdentity

What the project is.

§repository: RepositoryIdentity

What the checkout is.

§vcs: VcsState

What version control says.

§toolchains: Vec<ToolchainState>

The toolchains the repository declares, sorted by id.

§layer: LayerSummary

What the layer holds.

§workflows: WorkflowCatalogue

The workflows a person can run.

§providers: Vec<ProviderState>

The provider projections the policy declares, in the policy’s order.

§services: Vec<ServiceState>

The local services, in the order the service table declares them.

§reasoning: Option<ReasoningSummary>

Reasoning (ADR 0098): operational whatever the advisors, the mode in force, and how many optional advisors can be asked. Absent when the distribution declares none.

§diagnostics: Vec<Diagnostic>

Everything that went wrong or is worth knowing, in the order it was found.

§provenance: Vec<FieldSource>

Where every field came from.

Implementations§

Source§

impl RepositoryEnvironment

Source

pub fn schema_id() -> String

The schema identity a document of this shape carries.

Source

pub fn explain(&self, field: &str) -> Option<&FieldSource>

The provenance of one field, by its dotted name.

use majordomus_cli::environment::{FieldSource, RepositoryEnvironment};
let _ = env.explain("project.version");
Source

pub fn digest(&self) -> String

A digest of everything a reader would notice, excluding the moment it was taken. Two snapshots with the same digest say the same thing, which is how the banner decides whether a person has already seen this.

Source

pub fn news_digest(&self) -> String

The digest that decides whether a banner is news: Self::digest without the services.

The entry file watches the server’s lease, so a server coming up re-evaluates entry twice more — once when it claims the lease, once when it publishes its address — and a digest that counted the services made each of those a first look, drawing the whole box again at a person who had just seen it. A server arriving or leaving is not a different repository; the short form names the Cockpit when it answers.

use majordomus_cli::environment::RepositoryEnvironment;
// a server arriving or leaving is not a different repository, so clearing the
// services changes nothing this digest can see
let mut without = env.clone();
without.services.clear();
assert_eq!(env.news_digest(), without.news_digest());
// and with no services left, the two digests are the same value
assert_eq!(without.news_digest(), without.digest());
Source

pub fn service(&self, id: &str) -> Option<&ServiceState>

The service with this id.

Source

pub fn headline_diagnostic(&self) -> Option<&Diagnostic>

The worst thing in the snapshot worth telling a person about, when there is one.

Trait Implementations§

Source§

impl Clone for RepositoryEnvironment

Source§

fn clone(&self) -> RepositoryEnvironment

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 RepositoryEnvironment

Source§

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

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

impl<'de> Deserialize<'de> for RepositoryEnvironment

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 Eq for RepositoryEnvironment

Source§

impl JsonSchema for RepositoryEnvironment

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

Source§

fn eq(&self, other: &RepositoryEnvironment) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for RepositoryEnvironment

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
Source§

impl StructuralPartialEq for RepositoryEnvironment

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 ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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