     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47

    // Copyright 2015-2017 Parity Technologies (UK) Ltd.
    // This file is part of Parity.

    // Parity is free software: you can redistribute it and/or modify
    // it under the terms of the GNU General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.

    // Parity is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    // GNU General Public License for more details.

    // You should have received a copy of the GNU General Public License
    // along with Parity.  If not, see <http://www.gnu.org/licenses/>.

    //! Semantic version formatting and comparing.

    /// A version value with strict meaning. Use `as_u32` to convert to a simple integer.
    ///
    /// # Example
    /// ```
    /// extern crate ethcore_util as util;
    /// use util::semantic_version::*;
    ///
    /// fn main() {
    ///   assert_eq!(SemanticVersion::new(1, 2, 3).as_u32(), 0x010203);
    /// }
    /// ```
    pub struct SemanticVersion {
    	/// Major version - API/feature removals & breaking changes.
    	pub major: u8,
    	/// Minor version - API/feature additions.
    	pub minor: u8,
    	/// Tiny version - bug fixes.
    	pub tiny: u8,
    }

    impl SemanticVersion {
    	/// Create a new object.
    	pub fn new(major: u8, minor: u8, tiny: u8) -> SemanticVersion { SemanticVersion{major: major, minor: minor, tiny: tiny} }

    	/// Convert to a `u32` representation.
    	pub fn as_u32(&self) -> u32 { ((self.major as u32) << 16) + ((self.minor as u32) << 8) + self.tiny as u32 }
    }

    // TODO: implement Eq, Comparison and Debug/Display for SemanticVersion.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)