base16-0.2.1.0: RFC 4648-compliant Base16 encodings/decodings
Copyright (c) 2019 Emily Pillmore BSD-style Emily Pillmore Experimental portable None Haskell2010

Data.Text.Lazy.Encoding.Base16

Description

This module contains the combinators implementing the RFC 4648 specification for the Base16 encoding including unpadded and lenient variants for lazy textual values

Synopsis

# Documentation

Encode a lazy Text value in Base16 with padding.

Decode a Base16-encoded lazy Text value.

Arguments

 :: (ByteString -> Either err Text) convert a bytestring to text (e.g. decodeUtf8') -> Text Input text to decode -> Either (Base16Error err) Text

Attempt to decode a lazy Text value as Base16, converting from ByteString to Text according to some encoding function. In practice, This is something like decodeUtf8', which may produce an error.

Example:

decodeBase16With decodeUtf8'
:: Text -> Either (Base16Error UnicodeException) Text


Decode a Base16-encoded lazy Text value leniently, using a strategy that never fails.

Warning: in the conversion to unicode text, exceptions may be thrown. Please use decodeBase16' if you are unsure if you are working with base16-encoded values, or if you expect garbage.

N.B.: this is not RFC 4648-compliant. It may give you garbage if you're not careful!

Tell whether a lazy Text value is Base16-encoded.

Examples:

This example will fail. It conforms to the alphabet, but is not valid because it has an incorrect (odd) length.

>>> isBase16 "666f6"
False


This example will succeed because it satisfies the alphabet and is considered "valid" (i.e. of the correct size and shape).

>>> isBase16 "666f"
True


Tell whether a lazy Text value is a valid Base16 format.

This will not tell you whether or not this is a correct Base16 representation, only that it conforms to the correct shape. To check whether it is a true Base16 encoded Text value, use isBase16.

Examples:

This example will fail because it does not conform to the Hex alphabet.

>>> isValidBase16 "666f+/6"
False


This example will succeed because it satisfies the alphabet and is considered "valid" (i.e. of the correct size and shape), but is not correct base16 because it is the wrong shape.

>>> isValidBase16 "666f6"
True