Struct ListVersion 

pub struct ListVersion {
    pub major: u16,
    pub minor: u16,
    pub patch: u16,
}

A struct describing the version of a module in this crate.

List-containing modules in this crate have their own version, separate from the full crate version. A module on a 0.x.y version is subject to ANY change during a crate minor release, including removal of it entirely.

This system also exists so that you can use a breaking crate-level update, while knowing that you will not have to change any of your code, because the update only broke a specific list that you are not using.

Essentially, when using this crate, you should always use an exact version specifier =x.y.z, and only update when you have checked the new ListVersion of the list(s) you are using. The ListVersion of all of the lists is next to the module name in the README, and in module::VERSION.

See the SemVer specification for details on the meaning of “major”, “minor”, and “patch”.

Fields

major: u16

The major version of a module.

When this is 0, all items in the module are considered “experimental”, and may be removed at any crate minor release. Otherwise, the biggest change to any module will cause that level of crate update.

minor: u16

The minor version of a module.

patch: u16

The patch version of a module.

Implementations

impl ListVersion

pub fn experimental(self) -> bool

Returns whether this list is considered “experimental” or not.

An experimental list can have breaking changes in non-breaking crate releases.

pub fn compatible(self, other: ListVersion) -> bool

Returns whether self could be used when other was the specified version.

Examples

use linked_lists::ListVersion;
 
let version = ListVersion {
    major: 1,
    minor: 2,
    patch: 3,
};
 
let expected = linked_lists::ListVersion {
    major: 1,
    minor: 0,
    patch: 0
};
 
assert!(version.compatible(expected));

Trait Implementations

impl Clone for ListVersion

fn clone(&self) -> ListVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListVersion

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

Formats the value using the given formatter.

impl Display for ListVersion

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

Formats the value using the given formatter.

impl Copy for ListVersion