Struct re_build_info::crate_version::CrateVersion

pub struct CrateVersion {
    pub major: u8,
    pub minor: u8,
    pub patch: u8,
    pub meta: Option<Meta>,
}

The version of a Rerun crate.

Sub-set of semver supporting major.minor.patch-{alpha,rc}.N+dev.

The string value of build metadata is not preserved.

Examples: 1.2.3, 1.2.3-alpha.4, 1.2.3-alpha.1+dev.

-alpha.N+dev versions are used for local or CI builds. -alpha.N versions are used for weekly releases. -rc.N versions are used for release candidates as we’re preparing for a full release.

The version numbers (N) aren’t allowed to be very large (current max: 63). This limited subset is chosen so that we can encode the version in 32 bits in our .rrd files and on the wire.

Here is the current binary format:

major    minor    patch    meta
00000000 00000000 00000000 00NNNNNN
                           ▲▲▲    ▲
                           ││└─┬──┘
                           ││  └─ N
                           │└─ rc/dev
                           └─ alpha

The valid bit patterns for meta are:

• 10NNNNNN -> -alpha.N
• 11NNNNNN -> -alpha.N+dev
• 01NNNNNN -> -rc.N
• 00000000 -> none of the above

Fields

major: u8

minor: u8

patch: u8

meta: Option<Meta>

Implementations

impl CrateVersion

pub fn try_parse_from_build_info_string( s: impl AsRef<str>, ) -> Result<Self, String>

Attempts to parse a CrateVersion from a BuildInfo’s string representation (rerun --version).

Refer to BuildInfo as std::fmt::Display>::fmt to see what the string representation is expected to look like. Roughly:

<name> <semver> [<rust_info>] <target> <branch> <commit> <build_date>

impl CrateVersion

pub const LOCAL: Self = _

impl CrateVersion

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

pub fn is_release(&self) -> bool

True is this version has no metadata at all (rc, dev, alpha, etc).

I.e. it’s an actual, final release.

pub fn is_dev(&self) -> bool

Whether or not this build has a +dev suffix.

This is used to identify builds which are not explicit releases, such as local builds and CI builds for every commit.

pub fn is_alpha(&self) -> bool

Whether or not this is an alpha version (-alpha.N or -alpha.N+dev).

pub fn is_rc(&self) -> bool

Whether or not this is a release candidate (-rc.N).

pub fn from_bytes([major, minor, patch, meta]: [u8; 4]) -> Self

From a compact 32-bit representation crated with Self::to_bytes.

pub fn to_bytes(self) -> [u8; 4]

A compact 32-bit representation. See also Self::from_bytes.

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

impl CrateVersion

pub const fn parse(version_string: &'static str) -> Self

Parse a version string according to our subset of semver.

See CrateVersion for more information.

pub const fn try_parse( version_string: &'static str, ) -> Result<Self, &'static str>

Parse a version string according to our subset of semver.

See CrateVersion for more information.

Trait Implementations

impl Clone for CrateVersion

fn clone(&self) -> CrateVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CrateVersion

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

Formats the value using the given formatter.

impl Display for CrateVersion

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

Formats the value using the given formatter.

impl Ord for CrateVersion

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

Restrict a value to a certain interval.

impl PartialEq for CrateVersion

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for CrateVersion

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SizeBytes for CrateVersion

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

impl Copy for CrateVersion

impl Eq for CrateVersion

impl StructuralPartialEq for CrateVersion