base16-0.1.3.0: RFC 4648-compliant Base16 encodings/decodings

Copyright(c) 2020 Emily Pillmore
LicenseBSD-style
MaintainerEmily Pillmore <emilypi@cohomolo.gy>
StabilityExperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Data.ByteString.Base16

Description

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

Synopsis

Documentation

encodeBase16 :: ByteString -> Text Source #

Encode a ByteString value as Base16 Text with padding.

See: RFC-4648 section 8

encodeBase16' :: ByteString -> ByteString Source #

Encode a ByteString value as a Base16 ByteString value with padding.

See: RFC-4648 section 8

decodeBase16 :: ByteString -> Either Text ByteString Source #

Decode a padded Base16-encoded ByteString value.

See: RFC-4648 section 8

isBase16 :: ByteString -> Bool Source #

Tell whether a ByteString 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

isValidBase16 :: ByteString -> Bool Source #

Tell whether a ByteString 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 alphabet. To check whether it is a true Base16 encoded ByteString 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