Struct BackendVersion 

pub struct BackendVersion { /* private fields */ }

Backend version information.

Uses semantic versioning (SemVer) for version management. Backends with the same major version are considered compatible.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::new(1, 2, 3);
assert_eq!(version.major(), 1);
assert_eq!(version.minor(), 2);
assert_eq!(version.patch(), 3);

Implementations

impl BackendVersion

pub fn new(major: u64, minor: u64, patch: u64) -> Self

Create a new backend version.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::new(1, 2, 3);
assert_eq!(version.to_string(), "1.2.3");

pub fn parse(s: &str) -> Result<Self, Error>

Parse a version string.

Errors

Returns an error if the version string is invalid.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::parse("1.2.3").unwrap();
assert_eq!(version.major(), 1);

pub fn major(&self) -> u64

Get the major version number.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::new(1, 2, 3);
assert_eq!(version.major(), 1);

pub fn minor(&self) -> u64

Get the minor version number.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::new(1, 2, 3);
assert_eq!(version.minor(), 2);

pub fn patch(&self) -> u64

Get the patch version number.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::new(1, 2, 3);
assert_eq!(version.patch(), 3);

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

Check if this version is compatible with another version.

Two versions are compatible if they have the same major version number. This follows semantic versioning rules where major version changes indicate breaking changes.

Examples

use canlink_hal::BackendVersion;

let v1 = BackendVersion::new(1, 2, 3);
let v2 = BackendVersion::new(1, 3, 0);
let v3 = BackendVersion::new(2, 0, 0);

assert!(v1.is_compatible_with(&v2));
assert!(!v1.is_compatible_with(&v3));

pub fn satisfies(&self, req: &str) -> Result<bool, Error>

Check if this version satisfies a version requirement.

Examples

use canlink_hal::BackendVersion;

let version = BackendVersion::new(1, 2, 3);
assert!(version.satisfies("^1.0.0").unwrap());
assert!(!version.satisfies("^2.0.0").unwrap());

Errors

Returns an error if the requirement string cannot be parsed.

pub const fn as_semver(&self) -> &Version

Get the underlying semver Version.

Trait Implementations

impl Clone for BackendVersion

fn clone(&self) -> BackendVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackendVersion

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

Formats the value using the given formatter.

impl Display for BackendVersion

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

Formats the value using the given formatter.

impl From<BackendVersion> for Version

fn from(backend_version: BackendVersion) -> Self

Converts to this type from the input type.

impl From<Version> for BackendVersion

fn from(version: Version) -> Self

Converts to this type from the input type.

impl PartialEq for BackendVersion

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for BackendVersion

impl StructuralPartialEq for BackendVersion