Struct VersionRegistry 

pub struct VersionRegistry { /* private fields */ }

Version registry for tracking API changes

Implementations

impl VersionRegistry

pub fn new() -> Self

Create a new version registry

pub fn register_api( &mut self, name: impl Into<String>, module: impl Into<String>, since: Version, ) -> &mut Self

Register a new API

pub fn register_api_with_example( &mut self, name: impl Into<String>, module: impl Into<String>, since: Version, example: impl Into<String>, ) -> &mut Self

Register an API with usage example

pub fn deprecate_api( &mut self, name: &str, version: Version, replacement: Option<String>, ) -> Result<(), String>

Mark an API as deprecated

pub fn deprecate_api_with_example( &mut self, name: &str, version: Version, replacement: Option<String>, migration_example: impl Into<String>, ) -> Result<(), String>

Mark an API as deprecated with migration example

pub fn add_breaking_change( &mut self, apiname: &str, change: BreakingChange, ) -> Result<(), String>

Add a breaking change to an API

pub fn apis_in_version(&self, version: &Version) -> Vec<&ApiEntry>

Get all APIs available in a specific version

pub fn deprecated_apis_in_version(&self, version: &Version) -> Vec<&ApiEntry>

Get all deprecated APIs in a version

pub fn migration_guide(&self, from: &Version, to: &Version) -> String

Generate migration guide between versions

pub fn deprecation_timeline(&self) -> String

Generate a deprecation timeline

Trait Implementations

impl Default for VersionRegistry

fn default() -> Self

Returns the “default value” for a type.