Safe Haskell	None
Language	Haskell2010

Rzk.Version

Contents

The package version
The full build description

Description

Which build of rzk this is: the package version, the commit it was built from (when the build supplied one), the compiler and platform, and which Cabal flags it was built with.

The package version itself is generated by Cabal into Paths_rzk, an autogenerated other module of the library, so a tool that links rzk cannot import it. This module exposes it as part of the public API instead, together with the rest of the build details, so a consumer (the rzk executable, the rzk-game) can report which checker it is running.

Synopsis

version :: Version
versionString :: String
data VersionInfo = VersionInfo {
- versionInfoVersion :: Version
- versionInfoCommit :: Maybe String
- versionInfoCommitDate :: Maybe String
- versionInfoCompiler :: String
- versionInfoPlatform :: String
- versionInfoFlags :: [BuildFlag]
}
data BuildFlag = BuildFlag {
- buildFlagName :: String
- buildFlagState :: FlagState
}
data FlagState
- = FlagOn
- | FlagOff
versionInfo :: VersionInfo
buildFlags :: [BuildFlag]
ppVersionInfo :: VersionInfo -> String
isoCommitDate :: String -> String

The package version

version :: Version Source #

The version of the rzk package.

versionString :: String Source #

The version of the rzk package, rendered as a string (e.g. "0.11.2").

This is what rzk version prints, and tools scrape it as such, so it is deliberately just the version and nothing else.

The full build description

data VersionInfo Source #

Everything this build knows about itself.

Constructors

VersionInfo

Fields

versionInfoVersion :: Version
The package version.
versionInfoCommit :: Maybe String
The commit rzk was built from, when the build knew one (see buildCommit); Nothing otherwise.
versionInfoCommitDate :: Maybe String
The date of that commit, when it came from a repository (see buildCommitDate).
versionInfoCompiler :: String
The Haskell implementation, e.g. "ghc-9.10.3".
versionInfoPlatform :: String
Operating system and architecture, e.g. "darwin-aarch64".
versionInfoFlags :: [BuildFlag]
The Cabal flags this build was made with (see buildFlags).

Instances

Instances details

ToJSON VersionInfo Source #
Instance details Defined in Rzk.Version Methods toJSON :: VersionInfo -> Value # toEncoding :: VersionInfo -> Encoding # toJSONList :: [VersionInfo] -> Value # toEncodingList :: [VersionInfo] -> Encoding # omitField :: VersionInfo -> Bool #
Show VersionInfo Source #
Instance details Defined in Rzk.Version Methods showsPrec :: Int -> VersionInfo -> ShowS # show :: VersionInfo -> String # showList :: [VersionInfo] -> ShowS #
Eq VersionInfo Source #
Instance details Defined in Rzk.Version Methods (==) :: VersionInfo -> VersionInfo -> Bool # (/=) :: VersionInfo -> VersionInfo -> Bool #

data BuildFlag Source #

A Cabal flag of the rzk package, with the state this build has.

Constructors

BuildFlag
Fields buildFlagName :: String buildFlagState :: FlagState

Instances

Instances details

ToJSON BuildFlag Source #
Instance details Defined in Rzk.Version Methods toJSON :: BuildFlag -> Value # toEncoding :: BuildFlag -> Encoding # toJSONList :: [BuildFlag] -> Value # toEncodingList :: [BuildFlag] -> Encoding # omitField :: BuildFlag -> Bool #
Show BuildFlag Source #
Instance details Defined in Rzk.Version Methods showsPrec :: Int -> BuildFlag -> ShowS # show :: BuildFlag -> String # showList :: [BuildFlag] -> ShowS #
Eq BuildFlag Source #
Instance details Defined in Rzk.Version Methods (==) :: BuildFlag -> BuildFlag -> Bool # (/=) :: BuildFlag -> BuildFlag -> Bool #

data FlagState Source #

Whether a Cabal flag is on for this build.

Constructors

FlagOn
FlagOff

Instances

Instances details

ToJSON FlagState Source #
Instance details Defined in Rzk.Version Methods toJSON :: FlagState -> Value # toEncoding :: FlagState -> Encoding # toJSONList :: [FlagState] -> Value # toEncodingList :: [FlagState] -> Encoding # omitField :: FlagState -> Bool #
Show FlagState Source #
Instance details Defined in Rzk.Version Methods showsPrec :: Int -> FlagState -> ShowS # show :: FlagState -> String # showList :: [FlagState] -> ShowS #
Eq FlagState Source #
Instance details Defined in Rzk.Version Methods (==) :: FlagState -> FlagState -> Bool # (/=) :: FlagState -> FlagState -> Bool #

versionInfo :: VersionInfo Source #

The build description of the running rzk.

buildFlags :: [BuildFlag] Source #

Every Cabal flag of the package, each with the state this build has.

A tool that wants a language server can look up lsp here rather than run rzk lsp and see whether it fails.

Note that the state is what was compiled in, not what was asked for: the JavaScript and WebAssembly backends have no LSP support whatever the lsp flag says, and lsp reads as off in such a build.

ppVersionInfo :: VersionInfo -> String Source #

Render a build description as a block of lines, as printed by rzk version --full.

isoCommitDate :: String -> String Source #

Git's default commit date (Fri Aug 21 21:14:42 2026 +0300) as a plain ISO date (2026-08-21), which is the form rustc -vV reports. A date that does not parse is passed through unchanged.