Skip to content

base32.md

Latest commit

 

History

History
46 lines (29 loc) · 1.12 KB

base32.md

File metadata and controls

46 lines (29 loc) · 1.12 KB

Richy-Z/base32

An RFC 4648-compliant Base32 encoder/decoder in pure Lua.

Fully strips whitespace and padding on decode, and emits padding during encoding for standard compliance.

 Usage

local base32 = require("base32")

base32.encode(str)

Encodes a string into Base32 according to RFC 4648.

  • Padding with = is always added, as per the specification.
  • Case is always uppercased.
  • Output is a plain string.
print(base32.encode("foobar")) -- MZXW6YTBOI======

assert(encode("foobar") == "MZXW6YTBOI======")

 base32.decode(str)

Decodes a Base32 string into its original content.

  • Whitespace and padding are stripped automatically from the input string.
  • Returns nil, errorStr if invalid Base32 characters are encountered.
print(base32.decode("MZXW6YTBOI======")) -- foobar

print(base32.decode("MZXW6 YT B O I======")) -- foobar

assert(decode("M  ZX W6Y    TBOI======") == "foobar")

local ok, err = base32.decode("??")
assert(not ok)
print(err) -- Invalid base32 character: ?