Skip to main content

FormatVersion

Struct FormatVersion 

Source
pub struct FormatVersion {
    pub major: u32,
    pub minor: u32,
}
Expand description

A parsed MAJOR.MINOR format version.

§Compatibility policy

The version gate used to be string equality, which meant a v0.1 reader refused a v0.2 file even when the only change was an added record kind it already knew how to skip. That makes every additive change a breaking one, which defeats the point of having a minor version at all. The rule is now:

  • Same major, any minor → readable. Minor bumps are additive-only by contract: new record kinds, new optional fields. An older reader skips what it does not recognise (see AntReader::next_record) and still verifies the trailer, so it gets a truthful subset rather than an error.
  • Unknown record kinds are skipped, not fatal — within the same major. They are still hashed, so integrity still holds.
  • A different major → rejected, explicitly. A major bump is reserved for changes an old reader would silently MISREAD: changed field meanings, a different container framing, a removed or repurposed kind. Refusing is the only safe answer.
  • A newer minor is not an error, but it is a known unknown. AntReader::minor_ahead reports it so a caller can warn that the file may carry records this build did not surface.

Writers must therefore never change the meaning of an existing field within a major. If a change cannot be expressed additively, it needs a major bump.

Fields§

§major: u32

Major: different majors are mutually unreadable.

§minor: u32

Minor: additive-only within a major.

Implementations§

Source§

impl FormatVersion

Source

pub const CURRENT: FormatVersion

The version this build reads and writes.

Source

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

Parse "MAJOR.MINOR". A bare "1" is treated as 1.0.

Source

pub fn readable_by_current(&self) -> bool

Can this build read a file written at self?

Trait Implementations§

Source§

impl Clone for FormatVersion

Source§

fn clone(&self) -> FormatVersion

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FormatVersion

Source§

impl Debug for FormatVersion

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for FormatVersion

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FormatVersion

Source§

impl Ord for FormatVersion

Source§

fn cmp(&self, other: &FormatVersion) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for FormatVersion

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for FormatVersion

Source§

fn partial_cmp(&self, other: &FormatVersion) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for FormatVersion

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.