Struct VersioningRecord 

pub struct VersioningRecord { /* private fields */ }

Result of analysing the API versioning annotations of a specification.

Implementations

impl VersioningRecord

pub fn analyze(spec: &Specification) -> ParserResult<Option<VersioningRecord>>

Validates every API versioning annotation of a specification.

Validation always runs, even when no version is projected. Returns None for specifications without a @version enum, and fails when lifecycle annotations appear without one.

pub fn timeline(&self) -> &VersionTimeline

The version history declared by the @version enum.

pub fn project( &self, spec: &Specification, version: VersionId, ) -> ParserResult<Specification>

Projects version into an ordinary specification.

pub fn merge( &self, spec: &Specification, versions: &[VersionId], ) -> ParserResult<Specification>

Projects every selected version into one specification with one module per version, in timeline order.

Trait Implementations

impl Clone for VersioningRecord

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersioningRecord

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

Formats the value using the given formatter.