Struct version_track::Version

pub struct Version { /* private fields */ }

Tracks the changing state of the rebase file

Implementations

impl Version

pub const fn sentinel() -> Self

Creates a sentinel Self, that is useful as an initial non-version for caching. Any changes to this version will reset the internal state to a new value. Internally, this uses a Uuid with the maximum valid value, and an increment of usize::MAX.

See SENTINEL_VERSION for a constant sentinel value.

pub fn new() -> Self

Create a new Self instance with a random Uuid and an increment of 0.

pub fn reset(&mut self)

Reset to an initial state, with a new internal version tracker.

pub fn increment(&mut self)

Increment the internal internal version, if the increment overflows, then the internal Uuid is recreated with a new value, and the increment is set to 0.

See Self::increment_wrap for a version that does not update the internal Uuid on overflow.

pub fn increment_wrap(&mut self)

Increment the internal internal version, if the increment overflows, the increment resets to 0. This allows the internal Uuid to remain stable, and reusing older increments are okay.

See Self::increment for a version that refreshes the internal Uuid on overflow.

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

Check if the internal Uuid is the same for this version and another. This is useful for checking if the state being treated by this instance is the same as another.

Note that using Self::reset or Self::increment can update the internal Uuid, and result in this value returning false.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Version

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

Formats the value using the given formatter.

impl PartialEq<Version> for Version

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Version

impl Eq for Version

impl StructuralEq for Version

impl StructuralPartialEq for Version