Struct Version

pub struct Version {
    pub major: u8,
    pub minor: u8,
    pub patch: u16,
    pub dash_pre: String,
    pub code_name: Option<String>,
    pub commit_describe: Option<String>,
    pub commit_date: Option<String>,
}

CKB version

Fields

major: u8

The major version.

It is the x in x.y.z.

minor: u8

The minor version.

It is the y in x.y.z.

patch: u16

The patch version.

It is the z in x.y.z.

dash_pre: String

The pre-release version.

It is the part starting with -.

Examples

• v1.2.3: dash_pre is “”
• v1.2.3-rc1: dash_pre is “-rc1”

code_name: Option<String>

A nickname of the version.

commit_describe: Option<String>

The SHA of the last Git commit.

See get_commit_describe how to get it.

commit_date: Option<String>

The commit date of the last Git commit.

See get_commit_date how to get it.

Implementations

impl Version

pub fn short(&self) -> String

Returns short representation of the version.

It returns version in format like x.y.z or x.y.z-pre.

pub fn long(&self) -> String

Returns full representation of the version.

It adds extra information after the short version in parenthesis, for example:

0.36.0 (7692751 2020-09-21)

pub fn is_pre(&self) -> bool

Tells whether this is a pre-release version.

pub fn is_dirty(&self) -> bool

Tells whether this version is build from a dirty git working directory.

The dirty version is built from the source code which has uncommitted changes.

Trait Implementations

impl Clone for Version

fn clone(&self) -> Version

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Version

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

Formats the value using the given formatter.

impl Default for Version

fn default() -> Version

Returns the “default value” for a type.

impl Display for Version

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

Formats the value using the given formatter.