Struct Version

pub struct Version {
    pub major: usize,
    pub minor: usize,
    pub patch: usize,
    pub prerelease: Prerelease,
    pub build_metadata: BuildMetadata,
    /* private fields */
}

A parsed version string, conforming to a specific dialect.

Instances of Version can be compared against one another, and formatted as a string.

Example

use smvr::{Dialect, Version};
let version = Version::parse("0.1.4-beta", Dialect::Standard);

Fields

major: usize

The major version number.

minor: usize

The minor version number.

patch: usize

The patch version number.

prerelease: Prerelease

The prerelease identifier, if provided.

build_metadata: BuildMetadata

The build metadata, if provided.

Implementations

impl Version

pub fn parse(version: &str, dialect: Dialect) -> Result<Self, Error>

Parse a string into a Version instance, following a specific Semver dialect.

use smvr::{Dialect, Version};
let version = Version::parse("0.1.4-beta", Dialect::Standard);

Errors

If the version string is not valid for the chosen dialect, the first error encountered will be returned.

Panics

If the version string is not valid utf-8, a panic will occur.

Trait Implementations

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 PartialEq for Version

fn eq(&self, other: &Self) -> 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 PartialOrd for Version

fn partial_cmp(&self, other: &Self) -> 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.