Struct Version 

pub struct Version {
    pub major: u16,
    pub minor: u16,
}

A major.minor version identifier for either the canonical schema or the data-provider interface.

Examples

use fulltime_plugin_api::Version;

let host = Version::new(1, 3);
let plugin = Version::new(1, 2);
assert!(host.accepts(plugin));

Fields

major: u16

Major version. A mismatch is always incompatible.

minor: u16

Minor version. A host may run a plugin targeting an equal or lower minor version.

Implementations

impl Version

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

Creates a new version identifier.

pub const fn accepts(self, target: Self) -> bool

Returns whether self, acting as the host’s supported version, accepts a plugin declaring target as the version it was built against.

Compatible when the major versions match and the host’s minor version is equal to or greater than the plugin’s, since a higher host minor version is a superset of the fields or functions the plugin was built against.

Examples

use fulltime_plugin_api::Version;

assert!(Version::new(1, 3).accepts(Version::new(1, 2)));
assert!(!Version::new(1, 1).accepts(Version::new(1, 2)));
assert!(!Version::new(2, 0).accepts(Version::new(1, 9)));

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Version

impl Debug for Version

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

Formats the value using the given formatter.

impl Display for Version

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

Formats the value using the given formatter.

impl Eq for Version

impl FromStr for Version

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a "major.minor" version string.

Errors

Returns ParseVersionError if the string is not exactly two u16 components separated by a single ..

Examples

use fulltime_plugin_api::Version;

assert_eq!("1.2".parse(), Ok(Version::new(1, 2)));
assert!("1".parse::<Version>().is_err());

type Err = ParseVersionError

The associated error which can be returned from parsing.

impl Hash for Version

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 Version

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Version

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