Struct solo2::Version

pub struct Version {
    pub major: u16,
    pub minor: u16,
    pub patch: u16,
}

Version of a firmware.

The version must be encoded in certain places. To make the API somewhat useable (but admittedly also a bit weirder), we use:

• 10 bits for major
• 16 bits for minor
• 6 bits for patch

which gives offsets of 22 bits for major and 6 bits for minor in the u32.

Further, the minor version is at times interpreted as a “calver” encoding days since 2020-01-01. This is optional to use, “semver” works as well.

Fields

major: u16

minor: u16

patch: u16

Implementations

impl Version

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

For binary consumption, padded with zero bytes

pub fn to_semver(&self) -> String

For end-user consumption, period-separated, not BCD

pub fn minor_as_date(&self) -> NaiveDate

The minor version component in its interpretation as days since 2020-01-01

pub fn to_calver(&self) -> String

For end-user consumption.

Example: 1:20210624.0

pub fn timestamp_micros(&self) -> u64

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Version

fn deserialize<D>(
    deserializer: D
) -> Result<Version, <D as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a str> for Version

fn from(bcd: &'a str) -> Version

Converts to this type from the input type.

impl From<[u8; 4]> for Version

fn from(bytes: [u8; 4]) -> Version

Converts to this type from the input type.

impl Ord for Version

fn cmp(&self, other: &Version) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Version> for Version

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

fn partial_cmp(&self, other: &Version) -> 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 Serialize for Version

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Version

impl Eq for Version

impl StructuralEq for Version

impl StructuralPartialEq for Version