-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haskell binding to libversion
--   
--   Haskell binding to libversion, an advanced version string comparison
--   library
@package libversion
@version 0.1.0


-- | Bindings to libversion
module Foreign.Libversion

-- | newtype around <a>ByteString</a> that uses <a>compareVersion</a> to
--   implement the <a>Ord</a> instance
newtype VersionString
VersionString :: ByteString -> VersionString
[unVersionString] :: VersionString -> ByteString

-- | Flags to tune the comparison behavior
data VersionFlag
NoFlag :: VersionFlag

-- | <i>p</i> letter is treated as <i>patch</i> (post-release) instead of
--   <i>pre</i> (pre-release).
PIsPatch :: VersionFlag

-- | any letter sequence is treated as post-release (useful for handling
--   patchsets as in <tt>1.2foopatchset3.barpatchset4</tt>).
AnyIsPatch :: VersionFlag

-- | derive lowest possible version with the given prefix. For example,
--   lower bound for <tt>1.0</tt> is such imaginary version <tt>?</tt> that
--   it's higher than any release before <tt>1.0</tt> and lower than any
--   prerelease of <tt>1.0</tt>. E.g. <tt>0.999</tt> &lt; lower
--   bound(<tt>1.0</tt>) &lt; <tt>1.0alpha0</tt>.
LowerBound :: VersionFlag

-- | derive highest possible version with the given prefix. Oppisite of
--   <a>LowerBound</a>.
UpperBound :: VersionFlag

-- | Compare version strings <tt>v1</tt> and <tt>v2</tt>
compareVersion :: ByteString -> ByteString -> Ordering

-- | Compare version strings <tt>v1</tt> and <tt>v2</tt> with additional
--   flags
compareVersion' :: VersionFlag -> VersionFlag -> ByteString -> ByteString -> Ordering
instance Data.String.IsString Foreign.Libversion.VersionString
instance GHC.Base.Monoid Foreign.Libversion.VersionString
instance GHC.Base.Semigroup Foreign.Libversion.VersionString
instance GHC.Show.Show Foreign.Libversion.VersionString
instance GHC.Classes.Eq Foreign.Libversion.VersionFlag
instance GHC.Show.Show Foreign.Libversion.VersionFlag
instance GHC.Enum.Enum Foreign.Libversion.VersionFlag
instance GHC.Classes.Ord Foreign.Libversion.VersionString
instance GHC.Classes.Eq Foreign.Libversion.VersionString