Copyright | (c) 2020 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 lazy bytestrings
Synopsis
- encodeBase16 :: ByteString -> Text
- encodeBase16' :: ByteString -> ByteString
- decodeBase16 :: ByteString -> Either Text ByteString
- decodeBase16Lenient :: ByteString -> ByteString
- isBase16 :: ByteString -> Bool
- isValidBase16 :: ByteString -> Bool
Documentation
encodeBase16 :: ByteString -> Text Source #
Encode a lazy ByteString
value as Base16 Text
with padding.
See: RFC-4648 section 8
encodeBase16' :: ByteString -> ByteString Source #
Encode a lazy 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 lazy ByteString
value.
See: RFC-4648 section 8
decodeBase16Lenient :: ByteString -> ByteString Source #
Decode a Base16-encoded ByteString
value leniently, using a
strategy that never fails
N.B.: this is not RFC 4648-compliant. It may give you garbage if you're not careful!
isBase16 :: ByteString -> Bool Source #
Tell whether a lazy 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 lazy 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