base16-0.2.1.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.Short.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 :: ShortByteString -> Text Source #

Encode a ShortByteString value as Base16 Text with padding.

See: RFC-4648 section 8

decodeBase16Lenient :: ShortByteString -> ShortByteString Source #

Decode a Base16-encoded ShortByteString value leniently, using a strategy that never fails

N.B.: this is not RFC 4648-compliant

isBase16 :: ShortByteString -> Bool Source #

Tell whether a ShortByteString 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 :: ShortByteString -> Bool Source #

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