HORIZON HASKELLDocslts/ghc-9.10.xc74966e2026-09-27Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · c74966e · 2026-09-27

Modulebase32-0.4Haskell2010

Data.ByteString.Lazy.Base32.Hex

This module contains ByteString-valued combinators for implementing the RFC 4648 specification of the Base32hex encoding format. This includes strictly padded/unpadded decoding variants, as well as internal and external validation for canonicity.

  • 9 values
  • Packagebase32-0.4
  • Exports9
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceHex.hs

Encoding

4 declarations

Encode a ByteString value as Base32hex Text without padding. Note that for Base32hex, padding is optional. If you call this function, you will simply be encoding as Base32hex and stripping padding chars from the output.

See: RFC-4648 section 7

Examples:
Example1 expression
encodeBase32Unpadded "Sun""ADQMS"

Encode a ByteString value as Base32hex without padding. Note that for Base32hex, padding is optional. If you call this function, you will simply be encoding as Base32hex and stripping padding chars from the output.

See: RFC-4648 section 7

Examples:
Example1 expression
encodeBase32Unpadded' "Sun""ADQMS"

Decoding

3 declarations

Decode an arbitrarily padded Base32hex encoded ByteString value. If its length is not a multiple of 4, then padding chars will be added to fill out the input to a multiple of 4 for safe decoding as Base32hex-encoded values are optionally padded.

See: RFC-4648 section 7

Examples:
Example1 expression
decodeBase32 "ADQMS==="Right "Sun"
Example1 expression
decodeBase32 "ADQMS"Right "Sun"
Example1 expression
decodeBase32 "ADQMS==="Left "Base32-encoded bytestring has invalid padding"

Decode an unpadded Base32hex-encoded ByteString value. Input strings are required to be unpadded, and will undergo validation prior to decoding to confirm.

In general, unless unpadded Base32hex is explicitly required, it is safer to call decodeBase32.

See: RFC-4648 section 7

Examples:
Example1 expression
decodeBase32Unpadded "ADQMS"Right "Sun"
Example1 expression
decodeBase32Unpadded "ADQMS==="Left "Base32-encoded bytestring has invalid padding"

Decode a padded Base32hex-encoded ByteString value. Input strings are required to be correctly padded, and will be validated prior to decoding to confirm.

In general, unless padded Base32hex is explicitly required, it is safer to call decodeBase32.

See: RFC-4648 section 7

Examples:
Example1 expression
decodeBase32Padded "ADQMS==="Right "Sun"
Example1 expression
decodeBase32Padded "ADQMS"Left "Base32-encoded bytestring requires padding"

Validation

2 declarations
valueisBase32Hex :: ByteString -> Bool
#

Tell whether a ByteString is Base32hex-encoded.

Examples:
Example1 expression
isBase32Hex "ADQMS"True
Example1 expression
isBase32Hex "ADQMS==="True
Example1 expression
isBase32Hex "ADQMS=="False

Tell whether a ByteString is a valid Base32hex format.

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

Examples:
Example1 expression
isValidBase32Hex "ADQMS"True
Example1 expression
isValidBase32Hex "ADQMS="False
Example1 expression
isValidBase32Hex "ADQMS%"False