Struct PhaseId 

pub struct PhaseId { /* private fields */ }

A phase identifier — a major number, optionally with a minor number.

Ordering is (major, minor) with an absent minor sorting first, so 35 < 35.1 < 35.2 < 36.

Implementations

impl PhaseId

pub const fn new(major: u32) -> Self

An integer-numbered phase, e.g. 35.

pub const fn with_minor(major: u32, minor: u32) -> Self

A decimal-numbered phase, e.g. 35.1.

pub const fn major(self) -> u32

The major number — 35 for both 35 and 35.1.

pub const fn minor(self) -> Option<u32>

The minor number, if this phase has one.

pub fn from_json(value: Option<&Value>) -> Option<Self>

Reads a phase field out of a persisted JSON record, in either shape — a bare number (written before the widening, and still what an integer phase writes) or a string.

Returns None when the field is absent or is neither shape. Callers index rather than defaulting, so an absent field cannot read as a phase that happens to match.

pub fn matches_json(self, value: Option<&Value>) -> bool

Whether a persisted JSON phase field denotes this phase.

The minor number is part of the identity: phase 35’s records must not match phase 35.1, which is the same cross-matching hazard the artifact glob has.

pub fn padded(self) -> String

The zero-padded path form: 07, 35.1.

Only the major number is padded. 35.1 is already unambiguous and is exactly what GSD writes on disk as .planning/phases/35.1-*.

Trait Implementations

impl Clone for PhaseId

fn clone(&self) -> PhaseId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PhaseId

impl Debug for PhaseId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PhaseId

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Accepts either shape: a bare number (state files written before the widening) or a string ("35.1").

impl Display for PhaseId

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

Writes the canonical label, ignoring any width or fill specifier.

See the module docs: silently honouring {:02} here would let a leftover padding specifier build a path that looks right for 35 and is wrong for 35.1.

impl Eq for PhaseId

impl From<u32> for PhaseId

fn from(major: u32) -> Self

Converts to this type from the input type.

impl FromStr for PhaseId

type Err = ParsePhaseIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for PhaseId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PhaseId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PhaseId

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes an integer phase as a JSON number and a decimal phase as a string.

The number arm preserves the on-disk shape of every state-NN.json written before the widening, so an existing run is not disturbed by this change.

impl StructuralPartialEq for PhaseId