HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulepgp-wordlist-0.1.0.3Haskell2010

Data.Text.PgpWordlist

Translate between binary data and a human-readable collection of words.

  • 1 type
  • 2 values
valuetoText :: ByteString -> Text
#

Inverse of fromText, modulo whitespace count.

Example1 expression
toText (BSL.pack [104, 101, 108, 108, 111])"frighten glossary glucose handiwork gremlin"
valuefromText :: Text -> Either TranslationError ByteString
#

Convert a text of whitespace-separated words to their binary representation. The whitespace splitting behaviour is given by words.

Example1 expression
fromText (T.pack "frighten glossary glucose handiwork gremlin")Right "hello"

Invalid words are recognized:

Example1 expression
fromText (T.pack "frighten dragon glucose handiwork gremlin")Left (BadWord "dragon")

Typical mistakes include accidentally swapping numbers, which leads to a parity error:

Example1 expression
fromText (T.pack "frighten glucose glossary handiwork gremlin")Left (BadParity "glucose" 108)
datadata TranslationError
#

Possible translation errors from a list of PGP words to binary format.

Constructors

  • BadWord Text

    Word is not recognized

  • BadParity Text Word8

    Word is recognized, but from the wrong alphabet. Duplicates, omissions, and neighbour transpositions are often cause for this.

Instances3Eq, Ord, Show