validated-literals: Compile-time checking for partial smart-constructors

[ bsd3, data, library ] [ Propose Tags ]

To disallow invalid input it is common to define (new)types with hidden data constructors. Forcing the user to go through a smart-constructor that enforces invariants and returns Maybe ResultType, preventing the construction of data with invalid values.

However, it is also common to want to include literal values of such types in source text. Things of textual literals for HTML, HTTP, etc. In such cases smart-constructors force us to handle potential conversion failures at runtime, or abusing functions like fromJust to break away all the safety smart-constructors provide. All this despite the fact that we can statically know at compile time that the conversion will always succeed or always fails.

This package provides a typeclasses for using TH to validate the correctness of provided literals at compile. This lets you define, e.g., newtype Even = Even Integer and write:

x :: Even
x = $$(valid 38)

This will check, at compile time, that the provided Integer is, in fact, even and unwrap it from Maybe, avoiding the runtime check.


[Skip to Readme]
Versions [faq] 0.1.0, 0.2.0, 0.2.0.1, 0.3.0 (info)
Change log CHANGELOG.md
Dependencies base (>=4.9 && <4.14), template-haskell [details]
License BSD-3-Clause
Copyright Copyright © 2015-2019 Merijn Verstraaten
Author Merijn Verstraaten
Maintainer Merijn Verstraaten <merijn@inconsistent.nl>
Revised Revision 1 made by MerijnVerstraaten at Thu Aug 8 16:25:39 UTC 2019
Category Data
Home page https://github.com/merijn/validated-literals
Bug tracker https://github.com/merijn/validated-literals/issues
Source repo head: hg clone https://bitbucket.org/merijnv/validated-literals
head: git clone git+ssh://github.com:merijn/validated-literals
Uploaded by MerijnVerstraaten at Thu Jan 10 23:02:14 UTC 2019
Distributions NixOS:0.3.0
Downloads 1051 total (31 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for validated-literals-0.3.0

[back to package description]

validated-literals: Compile-time checking for partial smart-constructors

BSD3 Hackage Build Status

To disallow invalid input it is common to define (new)types with hidden data constructors. Forcing the user to go through a smart-constructor that enforces invariants and returns Maybe ResultType, preventing the construction of data with invalid values.

However, it is also common to want to include literal values of such types in source text. Things of textual literals for HTML, HTTP, etc. In such cases smart-constructors force us to handle potential conversion failures at runtime, or abusing functions like fromJust to break away all the safety smart-constructors provide. All this despite the fact that we can statically know at compile time that the conversion will always succeed or always fails.

This package provides a typeclasses for using TH to validate the correctness of provided literals at compile. This lets you define, e.g., newtype Even = Even Integer and write:

x :: Even
x = $$(valid 38)

This will check, at compile time, that the provided Integer is, in fact, even and unwrap it from Maybe, avoiding the runtime check.