Copyright	(c) 2020 Emily Pillmore
License	BSD-style
Maintainer	Emily Pillmore <emilypi@cohomolo.gy>
Stability	Experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Data.ByteString.Base32

Description

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

Synopsis

encodeBase32 :: ByteString -> Text
encodeBase32' :: ByteString -> ByteString
decodeBase32 :: ByteString -> Either Text ByteString
encodeBase32Unpadded :: ByteString -> Text
encodeBase32Unpadded' :: ByteString -> ByteString
decodeBase32Unpadded :: ByteString -> Either Text ByteString
isBase32 :: ByteString -> Bool
isValidBase32 :: ByteString -> Bool

Documentation

encodeBase32 :: ByteString -> Text Source #

Encode a ByteString value as Base32 Text with padding.

See: RFC-4648 section 4

encodeBase32' :: ByteString -> ByteString Source #

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

See: RFC-4648 section 4

decodeBase32 :: ByteString -> Either Text ByteString Source #

Decode a padded Base32-encoded ByteString value.

See: RFC-4648 section 4

encodeBase32Unpadded :: ByteString -> Text Source #

Encode a ByteString value as a Base32 Text value without padding.

See: RFC-4648 section 4

encodeBase32Unpadded' :: ByteString -> ByteString Source #

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

See: RFC-4648 section 4

decodeBase32Unpadded :: ByteString -> Either Text ByteString Source #

Decode an arbitarily padded Base32-encoded ByteString value.

See: RFC-4648 section 4

isBase32 :: ByteString -> Bool Source #

Tell whether a ByteString value is base32 encoded.

isValidBase32 :: ByteString -> Bool Source #

Tell whether a ByteString value is a valid Base32 format.

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