base32-lens: Optics for the Base32 library

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Prisms and pattern synonyms for the Base32 library

[Skip to Readme]

Properties

Versions	0.1.0.0, 0.1.1.0, 0.1.1.1, 0.2.0
Change log	CHANGELOG.md
Dependencies	base (>=4.10 && <5), base32 (>=0.4 && <0.5), bytestring (>=0.10 && <0.11), lens (>=4.0 && <5), text (>=1.2 && <1.3) [details]
License	BSD-3-Clause
Copyright	(c) 2020 Emily Pillmore
Author	Emily Pillmore
Maintainer	emilypi@cohomolo.gy
Category	Data
Home page	https://github.com/emilypi/base32-lens
Bug tracker	https://github.com/emilypi/base32-lens/issues
Source repo	head: git clone https://github.com/emilypi/base32.git
Uploaded	by topos at 2020-02-16T08:34:08Z

Modules

Data
- ByteString
  - Base32
    - Data.ByteString.Base32.Lens
- Text
  - Encoding
    - Base32
      - Data.Text.Encoding.Base32.Lens

Downloads

base32-lens-0.2.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

topos

For package maintainers and hackage trustees

edit package information

Readme for base32-lens-0.2.0

[back to package description]

Base32-lens

This package provides optics and convenient pattern synonyms for the base32 library.

Patterns

The pattern synonyms provided in this library are:

pattern Base32 :: ByteString -> ByteString
pattern Base32Url :: ByteString -> ByteString
pattern Base32UrlUnpadded :: ByteString -> ByteString

-- and

pattern Base32 :: Text -> Text
pattern Base32Url :: Text -> Text
pattern Base32UrlUnpadded :: Text -> Text

These provide a convenient high level interface for passing Base32 encoded values.

Optics

Prisms for encoding and decoding Text and ByteString values are given as part of the library:

_Base32 :: Prism' ByteString ByteString
_Base32Url :: Prism' ByteString ByteString
_Base32UrlUnpadded :: Prism' ByteString ByteString

-- and

_Base32 :: Prism' Text Text
_Base32Url :: Prism' Text Text
_Base32UrlUnpadded :: Prism' Text Text

If a particular structure has a Lens into some Text or ByteString value they might want to encode (or decode), then composing such a Lens with these Prisms yields an affine Traversal, resulting in a structure which has the focus of its Lens encoded as or decoded from Base32(-url).