Struct rocfl::ocfl::VersionNum

pub struct VersionNum {
    pub number: u32,
    pub width: u32,
}

Represents an OCFL object version.

Fields

number: u32

width: u32

Implementations

impl VersionNum

pub fn v1() -> Self

Creates a new VersionNum at version 1 with no zero-padding

pub fn v1_with_width(width: u32) -> Self

Creates a new VersionNum at version 1 with the specified zero-padding width

pub fn previous(&self) -> Result<VersionNum>

Returns the previous version, or an Error if the previous version is invalid (less than 1).

pub fn next(&self) -> Result<VersionNum>

Returns the next version, or an Error if the next version is invalid. Version number only have limits if they are zero-padded.

Trait Implementations

impl Clone for VersionNum

fn clone(&self) -> VersionNum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionNum

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionNum

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for VersionNum

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

Formats the value using the given formatter.

impl From<VersionNum> for String

fn from(version_num: VersionNum) -> Self

Performs the conversion.

impl From<VersionNum> for VersionRef

fn from(num: VersionNum) -> Self

Performs the conversion.

impl From<VersionNum> for ProblemLocation

fn from(version_num: VersionNum) -> Self

Performs the conversion.

impl FromStr for VersionNum

fn from_str(s: &str) -> Result<Self, Self::Err>

This function is used when parsing command line arguments. It attempts to interpret a string as a version if it is formatted like any of these examples: v3, v00009, or 8.

type Err = RocflError

The associated error which can be returned from parsing.

impl Hash for VersionNum

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for VersionNum

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<VersionNum> for VersionNum

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

impl PartialOrd<VersionNum> for VersionNum

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 Serialize for VersionNum

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ str> for VersionNum

fn try_from(version: &str) -> Result<Self, Self::Error>

Parses a string in the format of v1 or v0002 into a VersionNum. An error is return if the version string is invalid.

type Error = RocflError

The type returned in the event of a conversion error.

impl TryFrom<u32> for VersionNum

fn try_from(version: u32) -> Result<Self, Self::Error>

Parses a positive integer into a VersionNum. An error is returned if it is invalid.

type Error = RocflError

The type returned in the event of a conversion error.

impl Copy for VersionNum

impl Eq for VersionNum