Documentation

PackageVersion represents PVP version numbers. It is similar to Data.Version's Version except:

1. PackageVersion has no versionTags.

2. We enforce PVP invariants i.e.

   • Tags must have at least one component.
   • All components >= 0.
3. Trailing zeroes are ignored in Eq, Ord, Semigroup, and Monoid.

That is, we declare an equivalence class up to trailing zeroes. In particular, the Monoid identity is

[0] = { [0], [0,0], [0,0,0], ... } 

and its Semigroup instance takes the greatest version (based on Ord).

Note: Because we export the underlying list in various ways, (e.g. show), Eq's extensionality law,

x == y ==> f x == f y 

can be broken. Take care that you do not rely on this law if you are using its underlying NonEmpty Word (or String) representation.

Examples

>>> MkPackageVersion [0,0,0,0] == MkPackageVersion [0,0,0] True 

>>> MkPackageVersion [4,0,0] > MkPackageVersion [1,2,0,0] True 

>>> MkPackageVersion [5,6,0] <> MkPackageVersion [9,0,0] MkPackageVersion {unPackageVersion = 9 :| [0,0]} 

>>> MkPackageVersion [0,9] <> MkPackageVersion [0,9,0,0] MkPackageVersion {unPackageVersion = 0 :| [9]} 

Since: 0.1.0.0

Errors that can occur when validating PVP version numbers.

Since: 0.1.0.0

Errors that can occur when reading PVP version numbers.

Since: 0.1.0.0

Errors that can occur when reading PVP version numbers from a file.

Since: 0.1.0.0

Constructs a PackageVersion from an Int list. The list must be non-empty to match PVP's minimal A. Furthermore, all digits must be non-negative.

Examples

>>> mkPackageVersion [1,2] Right (MkPackageVersion {unPackageVersion = 1 :| [2]}) 

>>> mkPackageVersion [2,87,7,1] Right (MkPackageVersion {unPackageVersion = 2 :| [87,7,1]}) 

>>> mkPackageVersion [1,2,-3,-4,5] Left (ValidationErrorNegative (-3)) 

>>> mkPackageVersion [3] Right (MkPackageVersion {unPackageVersion = 3 :| []}) 

>>> mkPackageVersion [] Left ValidationErrorEmpty 

Since: 0.1.0.0

Displays PackageVersion in Text format.

Examples

>>> toText (MkPackageVersion [2,7,10,0]) "2.7.10.0" 

Since: 0.1.0.0