base16

Fast RFC 4648-compliant Base16 encoding

https://github.com/emilypi/base16

Version on this page:1.0@rev:1
LTS Haskell 22.39:1.0@rev:2
Stackage Nightly 2024-10-29:1.0@rev:2
Latest on Hackage:1.0@rev:2

See all snapshots base16 appears in

BSD-3-Clause licensed by Emily Pillmore
Maintained by [email protected]
This version can be pinned in stack with:base16-1.0@sha256:9366318622ec10e124929591015f1814e48c882a59d33ac612213935e8902003,2622

Module documentation for 1.0

Used by 2 packages in nightly-2024-09-10(full list with versions):
haskoin-core, secp256k1-haskell

Base16

Build Status Hackage

RFC 4648-compliant Base16 encoding and decoding.

For the companion optics and pattern synonyms, see base16-lens.

Summary

The following types have supported codecs:

  • Data.ByteString
  • Data.ByteString.Lazy
  • Data.ByteString.Short
  • Data.Text
  • Data.Text.Lazy
  • Data.Text.Short

Additionally this library has

  • Much better performance than base16-bytestring for encode and decode, with a more conventional api.
  • Support for mixed-case hex decoding (defaults to lower-case encoding by convention)
  • Optics for handling more complex structures with Base16 representations via the base16-lens package
  • Checks for both validity and correctness of Base16 encodings.

There are no dependencies aside from those bundled with GHC.

Changes

Revision history for base16

1.0

  • Revamp api (see: MIGRATION-1.0.md in the source repo)

    • Add new Base16 opaque wrapper for encoded strings
    • Move decode* to decode*Typed for untyped bytestring values
    • Make typed decoding the default
    • Optimize loops in the typed case

  • Bump lower bound on bytestring to bytestring-0.11

  • Bump lower bound on text to text-2.0

  • Support for all recent GHCs

  • Removed support for SafeHaskell

0.3.2.1

  • Add support for GHC 9.4
  • Added decodeBase16' to Data.ByteString.Base16* (thanks to @shlevy #20)

0.3.2.0

  • Fix incorrect behavior in Data.ByteString.Short.Base16#encodeBase16
  • Drop base GHC <8.10

0.3.0.1

  • Allow for mixed-case lenient decoding + validation
  • Bump testing for mixed-case hex

0.3.0.0

  • API for decodeBase16With has changed to require ByteString instead of Text. This is in alignment with work done on base64, which reflects the same API. This will be the final design for these types of conversions.
  • Test coverage now at 94%
  • Add NFData, Exception, and Generic instances for Base16Error + @since annotations for new instances. (#5)
  • Doc improvements and add -XTrustworty and -XSafe annotations where needed. (#5)
  • Optimized inner loop for short text and bytestrings (#4)
  • Changed encodeBase16 in ByteString.Short to produce ShortText, instead of Text.

0.2.1

  • Added support for Text.Short and ByteString.Short values

0.2.0.1

  • Improved performance. Decode and encode are now 3.5x-5x the next best lib.

0.2.0

  • Add lenient decoders
  • Fix bug in Text decodeBase16 which failed on invalid UTF-8 values as a result of decoding
  • Add decodeBase16With combinators

0.1.3

  • Add lazy variants for Text and ByteString values

0.1.2.1 – 2020-02-17

  • Documentation now references correct RFC section

0.1.2 – 2020-02-17

  • Unmask loops - now correct.

0.1.1 – 2020-02-17

  • Mask Word32 and Word64 loops (flaky)

0.1.0.0 – 2020-02-16

  • First version. Released on an unsuspecting world.