Headroom.Meta.Version

Description

This module contains data types and functions for working with Haskell PVP versions (https://pvp.haskell.org/faq/) in type safe way.

Synopsis

Documentation

Type safe representation of PVP version.

Constructors

Version
Fields vMajor1 :: Int first major version vMajor2 :: Int second major version vMinor :: Int minor version vPatch :: Int patch level version

Instances details

Eq Version Source #
Instance details Defined in Headroom.Meta.Version Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Ord Version Source #
Instance details Defined in Headroom.Meta.Version Methods compare :: Version -> Version -> Ordering # (<) :: Version -> Version -> Bool # (<=) :: Version -> Version -> Bool # (>) :: Version -> Version -> Bool # (>=) :: Version -> Version -> Bool # max :: Version -> Version -> Version # min :: Version -> Version -> Version #
Show Version Source #
Instance details Defined in Headroom.Meta.Version Methods showsPrec :: Int -> Version -> ShowS # show :: Version -> String # showList :: [Version] -> ShowS #
FromJSON Version Source #
Instance details Defined in Headroom.Meta.Version Methods parseJSON :: Value -> Parser Version # parseJSONList :: Value -> Parser [Version] #

Arguments

:: Text	input text to parse version from
-> Maybe Version	parsed `Version`

Parses Version from given text.

>>> parseVersion "0.3.2.0"
Just (Version {vMajor1 = 0, vMajor2 = 3, vMinor = 2, vPatch = 0})

Arguments

:: Version	`Version` to print
-> Text	textual representation

Prints Version in major1.major2.minor.patch format.

>>> printVersion (Version 0 3 2 0)
"0.3.2.0"

Similar to printVersion, but adds the v prefix in front of the version number.

>>> printVersionP (Version 0 3 2 0)
"v0.3.2.0"

QuasiQuoter for defining Version values checked at compile time.

>>> [pvp|1.2.3.4|]
Version {vMajor1 = 1, vMajor2 = 2, vMinor = 3, vPatch = 4}