Struct DocVersion 

pub struct DocVersion {
    pub major: u32,
    pub minor: u32,
}

A two-component ADR document version, e.g. 1.10.

Compared component-wise rather than lexically or as a decimal, because both of those readings sort 1.10 below 1.9 — and this repository has an ADR that reached 1.11 one row at a time.

Fields

major: u32

The part before the dot.

minor: u32

The part after it. 10 is a later revision than 9, not an earlier one.

Implementations

impl DocVersion

pub fn parse(s: &str) -> Option<Self>

Parse a string that is exactly X.Y.

A third component makes this None: 1.13.0 is a crate release, and reading its first two parts as a document version is the mistake this function exists to refuse.

Trait Implementations

impl Clone for DocVersion

fn clone(&self) -> DocVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DocVersion

impl Debug for DocVersion

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

Formats the value using the given formatter.

impl Display for DocVersion

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

Formats the value using the given formatter.

impl Eq for DocVersion

impl Ord for DocVersion

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DocVersion

fn partial_cmp(&self, other: &DocVersion) -> 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 StructuralPartialEq for DocVersion