The prefix-units package

[Tags: bsd3, library]

This library deals with parsing values containing "prefix units" (both binary and SI). For example, it can parse 10M and 1G, and it can also format values for displaying with the "optimal" unit. For more details, see the man page units(7), http://physics.nist.gov/cuu/Units/prefixes.html and http://physics.nist.gov/cuu/Units/binary.html.


[Skip to ReadMe]

Properties

Versions0.1.0, 0.1.0.1, 0.1.0.2
Change logCHANGES.md
Dependenciesbase (>=3 && <5) [details]
LicenseBSD3
Copyright(c) 2012, 2014 Google Inc.
AuthorIustin Pop <iustin@google.com>
MaintainerIustin Pop <iustin@google.com>
Stabilityalpha
CategoryData
Home pagehttps://github.com/iustin/prefix-units
Bug trackerhttps://github.com/iustin/prefix-units/issues
Source repositoryhead: git clone https://github.com/iustin/prefix-units.git
this: git clone https://github.com/iustin/prefix-units.git(tag prefix-units-v0.1.0.2)
UploadedMon Nov 24 05:48:27 UTC 2014 by IustinPop
UpdatedMon Nov 24 05:49:25 UTC 2014 by IustinPop to revision 1
DistributionsLTSHaskell:0.1.0.2, NixOS:0.1.0.2, Stackage:0.1.0.2
Downloads614 total (27 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for prefix-units-0.1.0.2

prefix-units package

This package defines a datatype (Unit) and associated parsing/formatting functions so that command line applications can handle "nice" values like:

$ cmd create-file foo 100G
Done.
$ cmd ls-file foo
Size is 100Gi
$ cmd ls-files
foo 100Gi
bar  14Ki

And so on. For details on the API, look at the Haddock documentation for the Data.Prefix.Units module.

For building and installing, cabal configure and related commands are enough. Run cabal configure --enable-tests && cabal build && cabal test if you want to run the unit-tests.

The library is designed to have very few dependencies (only base and a few GHC extensions), so that it's trivial to use it in projects. Hence the use of some hand-coded conversions instead of using TemplateHaskell to generate them automatically.

TODO

The current interface of the library works, but is not nicely composable. I'm still looking for a nicer way to expose the parsing functionality.

Currently, the binary and SI units are mixed in the same data-type. This works, but at some level I think two separate types would be more "correct", at the expense of a more complex API.

The RationalConvertible type class has only a few instances; ideally we'd have instance Integral a => RationalConvertible a and similar for Fractional, but this doesn't work as such in Haskell, so we're stuck with the manual derivation.

The current behaviour is case-sensitive for all units in ParseExact mode, which means that one has to use (in this mode) Ki for the binary unit Kibi. This seems suboptimal, since the binary units are unique irrespective of casing.