Skip to main content

VersionCompatibility

Enum VersionCompatibility 

Source
pub enum VersionCompatibility {
    Full,
    Degraded,
    Incompatible,
}
Expand description

Result of snapshot version compatibility analysis.

Returned by check_version to indicate whether a snapshot with a given format version can be read by this build of Hexz. This enum enables graceful handling of version mismatches with appropriate error messages.

§Variants

  • Full: Version is within MIN_SUPPORTED_VERSION..=MAX_SUPPORTED_VERSION and all features are supported. Proceed with normal operations.

  • Degraded: Version is newer than MAX_SUPPORTED_VERSION but forward compatibility rules allow partial reads with warnings. Unsupported features are ignored or substituted with defaults. (Not yet implemented; currently treated as Incompatible.)

  • Incompatible: Version is outside the supported range and cannot be read. The user must upgrade Hexz (for newer snapshots) or migrate the snapshot (for older snapshots).

§Examples

use hexz_core::format::version::{check_version, VersionCompatibility};

let result = check_version(1);
assert_eq!(result, VersionCompatibility::Full);

let result = check_version(999);
assert_eq!(result, VersionCompatibility::Incompatible);
assert!(!result.is_compatible());

Variants§

§

Full

Fully supported version with all features available.

§

Degraded

Newer version with partial support (warnings emitted, some features unavailable).

This variant is reserved for future forward compatibility modes. Currently, all versions outside the supported range are marked as Incompatible.

§

Incompatible

Incompatible version that cannot be read (too old or too new).

Implementations§

Source§

impl VersionCompatibility

Source

pub fn is_compatible(&self) -> bool

Tests whether the snapshot can be read with this compatibility status.

Returns true for Full and Degraded compatibility, indicating that read operations can proceed (possibly with warnings). Returns false for Incompatible, indicating that the snapshot must be rejected.

§Returns
  • true: Snapshot can be opened (possibly with limited functionality)
  • false: Snapshot cannot be opened (hard error)
§Examples
use hexz_core::format::version::{check_version, VersionCompatibility};

let compat = check_version(1);
if compat.is_compatible() {
    println!("Snapshot can be read");
} else {
    eprintln!("Snapshot is incompatible");
}

Trait Implementations§

Source§

impl Clone for VersionCompatibility

Source§

fn clone(&self) -> VersionCompatibility

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VersionCompatibility

Source§

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

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

impl Display for VersionCompatibility

Source§

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

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

impl PartialEq for VersionCompatibility

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for VersionCompatibility

Source§

impl Eq for VersionCompatibility

Source§

impl StructuralPartialEq for VersionCompatibility

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more