Struct SurfaceChange 

pub struct SurfaceChange {
    pub impact: Impact,
    pub direction: Direction,
    pub surface: SurfaceKind,
    pub capability: String,
    pub id: String,
    pub detail: String,
}

One movement of the public contract, with the reason it counts for what it does.

use majordomus_cli::release::compat::{Direction, Impact, SurfaceChange, SurfaceKind};
let change = SurfaceChange {
    impact: Impact::Major,
    direction: Direction::Removed,
    surface: SurfaceKind::Http,
    capability: "alpha.list".into(),
    id: "GET /api/v1/alpha".into(),
    detail: "the capability survives; this way of reaching it does not".into(),
};
assert_eq!(change.to_string(), "- route GET /api/v1/alpha");

Fields

impact: Impact

How much it moves the contract on its own.

direction: Direction

Added, removed, or altered.

surface: SurfaceKind

Which promise it is.

capability: String

The capability it belongs to.

id: String

The thing itself: GET /api/v1/foo, majordomus_release_analysis, release.analysis.

detail: String

Why this impact and not a smaller one, in one clause.

Trait Implementations

impl Clone for SurfaceChange

fn clone(&self) -> SurfaceChange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurfaceChange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SurfaceChange

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SurfaceChange

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

Formats the value using the given formatter.

impl Eq for SurfaceChange

impl JsonSchema for SurfaceChange

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 SurfaceChange

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

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 SurfaceChange