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

Modulebase16-1.0Haskell2010

Data.Text.Short.Encoding.Base16

This module contains ShortText-valued combinators for implementing the RFC 4648 specification of the Base16 encoding format. This includes lenient decoding variants, as well as internal and external validation for canonicity.

  • 7 values
  • Packagebase16-1.0
  • Exports7
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceBase16.hs
valuedecodeBase16With
  1. :: (ShortByteString -> Either err ShortText)

    convert a bytestring to text (e.g. T.decodeUtf8')

  2. -> ShortByteString

    Input to decode

  3. -> Either (Base16Error err) ShortText
#

Attempt to decode an untyped 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 (fmap fromText . decodeUtf8' . fromShort)
  :: ShortByteString -> Either (Base16Error UnicodeException) ShortText

Decode an untyped Base16-encoded 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.

Examples:
Example1 expression
decodeBase16Lenient "53756e""Sun"
Example1 expression
decodeBase16Lenient "6x6x""f"
valueisBase16 :: ShortText -> Bool
#

Tell whether a ShortText value is Base16-encoded.

Examples:
Example1 expression
isBase16 "666f6"False
Example1 expression
isBase16 "666f"True
valueisValidBase16 :: ShortText -> Bool
#

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:
Example1 expression
isValidBase16 "666f+/6"False
Example1 expression
isValidBase16 "666f6"True