base64: RFC 4648-compliant padded and unpadded base64 and base64url encodings

[ bsd3, data, library ] [ Propose Tags ]

RFC 4648-compliant padded and unpadded base64 and base64url encoding and decoding.


[Skip to Readme]
Versions [faq] 0.0.1.0, 0.1.0.0, 0.2.0.0, 0.3.0.0, 0.3.1.0, 0.3.1.1 (info)
Change log CHANGELOG.md
Dependencies base (>=4.10 && <5), bytestring (==0.10.*), deepseq (==1.4.*), text (==1.2.*) [details]
License BSD-3-Clause
Copyright (c) 2019 Emily Pillmore
Author Emily Pillmore
Maintainer emilypi@cohomolo.gy
Category Data
Home page https://github.com/emilypi/base64
Bug tracker https://github.com/emilypi/base64/issues
Source repo head: git clone https://github.com/emilypi/base64.git
Uploaded by topos at Wed Jan 15 20:15:20 UTC 2020
Distributions
Downloads 198 total (198 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2020-01-15 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for base64-0.3.1.1

[back to package description]

Base64

Build Status Hackage

Padded and unpadded base64 and base64url encoding and decoding for Text and ByteString values.

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

Summary

What does this library provide? Here is the summary:

  • Good performance compared to existing Base64 libraries (see PERFORMANCE.md)
  • Support for padded and unpadded Base64 and Base64url
  • Support for Text encodings and decodings
  • Optics for handling more complex structures with Base64 representations via the base64-lens package
  • Checks for both valid Base64 and correct Base64 and Base64url encodings

There are no dependencies aside from those bundled with GHC:

base64 dependencies

Motivation

Haskell has two main libraries for Base64: memory, and base64-bytestring.

Of these, memory is geared towards integration with other memory primitives in the library, without much of an eye towards performance, while base64-bytestring is built to exclusively address ByteString encoding and decoding, and is very performant. Many great strides have been made in the realm of Base64 performance and vectorization just in the past 5 years, which this library attempts to capture. Additionally, we attempt to fix perceived shortcomings with both APIs in the support of unpadded Base64 and Base64-url support (which memory provides, but not base64-bytestring), as well as supporting Text values (neither libraries provide).