Documentation

PackageVersion represents PVP version numbers. It is similar to Data.Version's Version (i.e. wraps a [Int]) except:

1. PackageVersion has no versionTags.
2. We enforce PVP's "tags must be at least A.B" invariant via the smart-constructor pattern.
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], ... }

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 [Int] (or String) representation.

Examples

>>> UnsafePackageVersion [0,0,0,0] == UnsafePackageVersion [0,0,0]
True

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

>>> UnsafePackageVersion [5,6,0] <> UnsafePackageVersion [9,0,0]
UnsafePackageVersion {unPackageVersion = [9,0,0]}

>>> UnsafePackageVersion [0,9] <> UnsafePackageVersion [0,9,0,0]
UnsafePackageVersion {unPackageVersion = [0,9]}

>>> TR.readEither @PackageVersion "UnsafePackageVersion {unPackageVersion = [3,2,1]}"
Right (UnsafePackageVersion {unPackageVersion = [3,2,1]})

>>> TR.readEither @PackageVersion "UnsafePackageVersion {unPackageVersion = [3]}"
Left "Prelude.read: no parse"

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

Smart constructor for PackageVersion. The length of the list must be > 1 to match PVP's minimal A.B. Furthermore, all digits must be non-negative.

Examples

>>> mkPackageVersion [1,2]
Right (UnsafePackageVersion {unPackageVersion = [1,2]})

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

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

>>> mkPackageVersion [3]
Left (VTooShortErr [3])

>>> mkPackageVersion []
Left (VTooShortErr [])

Since: 0.1.0.0

Displays PackageVersion in Text format.

Examples

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

Since: 0.1.0.0