Retracted: these held pkg/ and internal/, now a module per pkg/v1 family and github.com/kitsunium/sdk/internal (ADR 0171): go get github.com/kitsunium/sdk@latest && go mod tidy
Documentation
¶
Overview ¶
Package baseenc — Base45 (RFC 9285) alphabet codec. Unlike base16/32/64 and ascii85, the stdlib ships no base45 encoder, so the encode/decode transforms live here. Base45 is a block encoding (base45PairBytes input bytes → base45GroupChars output chars; a trailing byte → base45TailChars chars), hence O(n) — safe to share the 10 MiB maxBaseEncBytes cap with the stdlib-backed variants.
Package baseenc — Base58 (Bitcoin alphabet) base-conversion codec.
Package baseenc — Base62 (0-9A-Za-z) base-conversion codec.
Package baseenc — big-endian base-conversion arithmetic shared by the Base58 and Base62 variants. Unlike the block encodings, these treat the whole input as one integer and divide it down by the radix, so the transforms are O(n²) — callers MUST cap input at maxConvBytes first.
Package baseenc — buffered writer used by variants whose stdlib has no streaming encoder (base16 uppercase). Held in its own file so the KTN-STRUCT-ONEFILE rule sees exactly one exported-shape struct per file.
Package baseenc implements a family of codec.Codec wrappers around the stdlib byte encodings (base16 / base32 / base64 / ascii85). Each variant registers itself with the core/data/codec registry under a distinct Name — the variant discriminator is the registered Format, not a tagged enum.
Universal Marshal flow: encode v with encoding/json, then base-N encode the resulting bytes. Unmarshal reverses the pipeline. The JSON layer is intentional — base-N alphabets are structureless, so flattening through JSON gives consumers a single Marshal/Unmarshal contract over any value.
Blank-importing this package registers all six variants at process start via package-level var initialisers; no init() function involved.
Package baseenc — buffered decode reader for variants whose stdlib has no streaming decoder (Base45). Held in its own file so KTN-STRUCT-ONEFILE sees exactly one struct per file.
Package baseenc — adapts the base-N stream-reader pipeline to codec.Decoder. Each Decode call drives a stdlib json.Decoder over the base-N decoded byte stream wrapped around the caller's io.Reader.
Package baseenc — adapts the base-N stream-writer pipeline to codec.Encoder. Each Encode call serialises one JSON value into the underlying base-N WriteCloser, which writes the encoded bytes onto the caller's io.Writer.
Package baseenc — IO adapters used by the streaming pipeline.
Package baseenc — per-variant identity table.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // Base64 is the RFC 4648 standard base64 codec. Base64 codec.Codec = codec.Register(&baseencCodec{variant: variantBase64}) // Base64URL is the RFC 4648 URL-safe base64 codec. Base64URL codec.Codec = codec.Register(&baseencCodec{variant: variantBase64URL}) // Base32 is the RFC 4648 standard base32 codec. Base32 codec.Codec = codec.Register(&baseencCodec{variant: variantBase32}) // Base16 is the uppercase hex codec. Base16 codec.Codec = codec.Register(&baseencCodec{variant: variantBase16}) // Hex is the lowercase hex codec. Hex codec.Codec = codec.Register(&baseencCodec{variant: variantHex}) // ASCII85 is the Adobe Ascii85 codec. ASCII85 codec.Codec = codec.Register(&baseencCodec{variant: variantASCII85}) // Base45 is the RFC 9285 Base45 codec (QR-code alphanumeric safe). Base45 codec.Codec = codec.Register(&baseencCodec{variant: variantBase45}) // Base58 is the Bitcoin Base58 codec (base-conversion; short inputs only). Base58 codec.Codec = codec.Register(&baseencCodec{variant: variantBase58}) // Base62 is the Base62 codec (base-conversion; short inputs only). Base62 codec.Codec = codec.Register(&baseencCodec{variant: variantBase62}) )
Singletons — registered with the core/data/codec registry at package load. Binding each registration result to a typed package-level var keeps us clear of init() and lets downstream callers refer to a specific variant.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files