Copyright | (c) 2019 Emily Pillmore |
---|---|
License | BSD-style |
Maintainer | Emily Pillmore <emilypi@cohomolo.gy> |
Stability | Experimental |
Portability | portable |
Safe Haskell | None |
Language | Haskell2010 |
This module contains the combinators implementing the RFC 4648 specification for the Base16 encoding including unpadded and lenient variants for text values
Synopsis
- encodeBase16 :: ShortText -> ShortText
- decodeBase16 :: ShortText -> Either Text ShortText
- decodeBase16With :: (ShortByteString -> Either err ShortText) -> ShortText -> Either (Base16Error err) ShortText
- decodeBase16Lenient :: ShortText -> ShortText
- isBase16 :: ShortText -> Bool
- isValidBase16 :: ShortText -> Bool
Documentation
encodeBase16 :: ShortText -> ShortText Source #
Encode a ShortText
value in Base16 with padding.
See: RFC-4648 section 8
decodeBase16 :: ShortText -> Either Text ShortText Source #
Decode a Base16-encoded lazy ShortText
value.
See: RFC-4648 section 8
:: (ShortByteString -> Either err ShortText) | convert a bytestring to text (e.g. |
-> ShortText | Input text to decode |
-> Either (Base16Error err) ShortText |
Attempt to decode a lazy ShortText
value as Base16, converting from
ByteString
to ShortText
according to some encoding function. In practice,
This is something like decodeUtf8'
, which may produce an error.
See: RFC-4648 section 8
Example:
decodeBase16With
decodeUtf8'
::ShortText
->Either
(Base16Error
UnicodeException
)ShortText
decodeBase16Lenient :: ShortText -> ShortText Source #
Decode a Base16-encoded lazy ShortText
value leniently, using a
strategy that never fails, catching unicode exceptions raised in the
process of converting to text values.
N.B.: this is not RFC 4648-compliant.
isBase16 :: ShortText -> Bool Source #
Tell whether a ShortText
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 :: ShortText -> Bool Source #
Tell whether a ShortText
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 ShortText
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