diff options
| author | Jeroen van Rijn <Kelimion@users.noreply.github.com> | 2025-10-10 12:24:28 +0200 |
|---|---|---|
| committer | Jeroen van Rijn <Kelimion@users.noreply.github.com> | 2025-10-10 12:24:28 +0200 |
| commit | ece213afca742bb91e9328230fd21b6b94c85662 (patch) | |
| tree | bd53a386f09c717dfb8c1af903e95599a22ca6a5 /core/encoding/base32 | |
| parent | 4068eeb5fae3981b34a5e5ae96e7c1b0c0eedc85 (diff) | |
Render examples.
Diffstat (limited to 'core/encoding/base32')
| -rw-r--r-- | core/encoding/base32/base32.odin | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/core/encoding/base32/base32.odin b/core/encoding/base32/base32.odin index d49d62f77..f50db12b3 100644 --- a/core/encoding/base32/base32.odin +++ b/core/encoding/base32/base32.odin @@ -1,22 +1,22 @@ -// `Base32` encoding and decoding, as specified in `RFC 4648`. -package encoding_base32 +/* +`Base32` encoding and decoding, as specified in `RFC 4648`. + +[[ RFC 4648; https://www.rfc-editor.org/rfc/rfc4648.html ]] -// Base32 encoding/decoding implementation as specified in RFC 4648. -// [[ More; https://www.rfc-editor.org/rfc/rfc4648.html ]] +A secondary param can be used to supply a custom alphabet to `encode` and a matching decoding table to `decode`. +If none is supplied it just uses the standard Base32 alphabet. +In case your specific version does not use padding, you may +truncate it from the encoded output. -// @note(zh): Encoding utility for Base32 -// A secondary param can be used to supply a custom alphabet to -// @link(encode) and a matching decoding table to @link(decode). -// If none is supplied it just uses the standard Base32 alphabet. -// In case your specific version does not use padding, you may -// truncate it from the encoded output. +Error represents errors that can occur during base32 decoding operations. +As per RFC 4648: +- Section 3.3: Invalid character handling +- Section 3.2: Padding requirements +- Section 6: Base32 encoding specifics (including block size requirements) +*/ +package encoding_base32 -// Error represents errors that can occur during base32 decoding operations. -// As per RFC 4648: -// - Section 3.3: Invalid character handling -// - Section 3.2: Padding requirements -// - Section 6: Base32 encoding specifics (including block size requirements) Error :: enum { None, Invalid_Character, // Input contains characters outside the specified alphabet |