Struct abi_stable::sabi_types::version::VersionStrings

#[repr(transparent)]
pub struct VersionStrings {
    pub version: RStr<'static>,
}

The <major>.<minor>.<patch> version of a library,

Post 1.0 major version

Major versions are mutually incompatible for both users and implementors.

Minor allow users to have a version less than or equal to that of the implementor, and disallows implementors from making changes that would break any previous minor release (with the same major number).

Patch cannot change the api/abi of the library at all,fixes only.

Pre 1.0 version

Minor versions are mutually incompatible for both users and implementors.

Patch cannot change the api/abi of the library at all,fixes only.

Example

use abi_stable::sabi_types::VersionStrings;

let v1_0_0 = VersionStrings::new("1.0.0").parsed().unwrap();
let v1_0_5 = VersionStrings::new("1.0.5").parsed().unwrap();
let v1_1_0 = VersionStrings::new("1.1.0").parsed().unwrap();
let v2_0_0 = VersionStrings::new("1.0.5").parsed().unwrap();

assert!(v1_0_0.is_compatible(v1_0_5), "'{}' '{}'", v1_0_0, v1_0_5);
assert!(v1_0_5.is_compatible(v1_1_0), "'{}' '{}'", v1_0_5, v1_1_0);
assert!(!v1_1_0.is_compatible(v2_0_0), "'{}' '{}'", v1_1_0, v2_0_0);

Fields

version: RStr<'static>

The major.minor.patch version string

Implementations

impl VersionStrings

pub const fn new(version: &'static str) -> Self

Constructs a VersionStrings from a string with the “major.minor.patch” format,where each one is a valid number.

This does not check whether the string is correctly formatted, that check is done inside VersionStrings::parsed.

Example

use abi_stable::sabi_types::VersionStrings;

static VERSION: VersionStrings = VersionStrings::new("0.1.2");

pub fn parsed(self) -> Result<VersionNumber, ParseVersionError>

Attempts to convert a VersionStrings into a VersionNumber

Errors

This returns a ParseVersionError if the string is not correctly formatted.

Example

use abi_stable::sabi_types::{VersionNumber, VersionStrings};

static VERSION: VersionStrings = VersionStrings::new("0.1.2");

assert_eq!(
    VERSION.parsed(),
    Ok(VersionNumber {
        major: 0,
        minor: 1,
        patch: 2
    })
);

let err_version = VersionStrings::new("0.a.2.b");
assert!(err_version.parsed().is_err());

Trait Implementations

impl Clone for VersionStrings

fn clone(&self) -> VersionStrings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionStrings

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

Formats the value using the given formatter.

impl Display for VersionStrings

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

Formats the value using the given formatter.

impl GetStaticEquivalent_ for VersionStrings

type StaticEquivalent = _static_VersionStrings

The 'static equivalent of Self

impl PartialEq for VersionStrings

fn eq(&self, other: &VersionStrings) -> 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 StableAbi for VersionStrings

type IsNonZeroType = <RStr<'static> as StableAbi>::IsNonZeroType

Whether this type has a single invalid bit-pattern.

const LAYOUT: &'static TypeLayout = _

The layout of the type provided by implementors.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.

impl Copy for VersionStrings

impl Eq for VersionStrings

impl StructuralPartialEq for VersionStrings