Struct SchemaVersion 

pub struct SchemaVersion {
    pub major: u32,
    pub minor: u32,
    pub patch: u32,
}

Schema version identifier.

Represents the version of a type’s schema using semantic versioning.

Examples

use hedl_core::schema_version::SchemaVersion;

// Create a version
let v1 = SchemaVersion::new(1, 0, 0);
let v2 = SchemaVersion::new(1, 1, 0);

// Compare versions
assert!(v2 > v1);
assert!(v2.is_compatible_with(&v1));

Fields

major: u32

Major version (breaking changes)

minor: u32

Minor version (backward-compatible additions)

patch: u32

Patch version (bug fixes)

Implementations

impl SchemaVersion

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

Create a new schema version.

Arguments

• major - Major version number
• minor - Minor version number
• patch - Patch version number

Examples

use hedl_core::schema_version::SchemaVersion;

let version = SchemaVersion::new(1, 2, 3);
assert_eq!(version.major, 1);
assert_eq!(version.minor, 2);
assert_eq!(version.patch, 3);

pub const fn v1() -> Self

Create version 1.0.0 (common default).

pub fn is_compatible_with(&self, other: &Self) -> bool

Check if this version is compatible with another version.

Compatibility rules:

• Same major version required
• This version’s minor must be >= other’s minor

Arguments

• other - The version to check compatibility with

Returns

true if this schema can read data written for other

Examples

use hedl_core::schema_version::SchemaVersion;

let v1_0 = SchemaVersion::new(1, 0, 0);
let v1_1 = SchemaVersion::new(1, 1, 0);
let v2_0 = SchemaVersion::new(2, 0, 0);

// v1.1 can read v1.0 data (backward compatible)
assert!(v1_1.is_compatible_with(&v1_0));

// v1.0 cannot read v1.1 data (missing new fields)
assert!(!v1_0.is_compatible_with(&v1_1));

// Different major versions are not compatible
assert!(!v2_0.is_compatible_with(&v1_0));

pub fn is_breaking_from(&self, other: &Self) -> bool

Check if this is a breaking change from another version.

A breaking change occurs when the major version increases.

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

Parse a version string in “major.minor.patch” format.

Arguments

• s - Version string to parse

Returns

Some(SchemaVersion) if parsing succeeds, None otherwise

Examples

use hedl_core::schema_version::SchemaVersion;

let v = SchemaVersion::parse("1.2.3").unwrap();
assert_eq!(v, SchemaVersion::new(1, 2, 3));

// Short forms also work
let v = SchemaVersion::parse("1.2").unwrap();
assert_eq!(v, SchemaVersion::new(1, 2, 0));

let v = SchemaVersion::parse("1").unwrap();
assert_eq!(v, SchemaVersion::new(1, 0, 0));

Trait Implementations

impl Clone for SchemaVersion

fn clone(&self) -> SchemaVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaVersion

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

Formats the value using the given formatter.

impl Default for SchemaVersion

fn default() -> Self

Returns the “default value” for a type.

impl Display for SchemaVersion

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

Formats the value using the given formatter.

impl FromStr for SchemaVersion

Parse a schema version from a string.

type Err = &'static str

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 SchemaVersion

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 SchemaVersion

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

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

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

impl Eq for SchemaVersion

impl StructuralPartialEq for SchemaVersion