Enum Impact 

pub enum Impact {
    None,
    Patch,
    Minor,
    Major,
}

How much a change moves the contract.

Ordered, so that “the declared bump covers what is required” is a comparison rather than a table:

use majordomus_cli::release::compat::Impact;
assert!(Impact::Major > Impact::Minor);
assert!(Impact::Minor > Impact::Patch);
assert!(Impact::Patch > Impact::None);

Variants

None

The contract did not move.

Patch

It moved behind the boundary: a caller cannot tell.

Minor

Something arrived; every existing caller still works.

Major

Something a caller could hold is gone or changed under it.

Implementations

impl Impact

pub fn as_str(self) -> &'static str

The word every surface renders: the command line’s report, the JSON every machine surface answers with, the Cockpit’s badge and the gate’s refusal all print this and never a wording of their own.

use majordomus_cli::release::compat::Impact;
assert_eq!(Impact::Major.as_str(), "major");
assert_eq!(Impact::None.as_str(), "none");

pub fn parse(word: &str) -> Option<Impact>

The impact a word names.

Every impact round-trips through its word, and nothing else is one:

use majordomus_cli::release::compat::Impact;
assert_eq!(Impact::parse("minor"), Some(Impact::Minor));
assert_eq!(Impact::parse("enormous"), None);

Trait Implementations

impl Clone for Impact

fn clone(&self) -> Impact

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Impact

impl Debug for Impact

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Impact

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Impact

impl JsonSchema for Impact

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 Ord for Impact

fn cmp(&self, other: &Impact) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Impact

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

fn partial_cmp(&self, other: &Impact) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Impact

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 Impact