base16-lens: Optics for the Base16 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 Base16 library


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.1.3.0, 0.1.3.1, 0.1.3.2
Change log CHANGELOG.md
Dependencies base (>=4.10 && <5), base16 (==0.1.*), bytestring (==0.10.*), lens (>=4.0 && <5), text (==1.2.*) [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/base16-lens
Bug tracker https://github.com/emilypi/base16-lens/issues
Source repo head: git clone https://github.com/emilypi/base16.git
Uploaded by topos at 2020-02-17T20:50:40Z

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for base16-lens-0.1.0.0

[back to package description]

Base16-lens

Build Status Hackage

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

Patterns

The pattern synonyms provided in this library are:

pattern Hex :: ByteString -> ByteString
-- and
pattern Hex :: Text -> Text

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

Optics

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

_Hex :: Prism' ByteString ByteString

-- and

_Hex:: 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 Base16.