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
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cache is the public facade for the SDK's caching, and it offers two surfaces because there are two different jobs.
|
Package cache is the public facade for the SDK's caching, and it offers two surfaces because there are two different jobs. |
|
Package codec is the universal encoder/decoder dispatch facade.
|
Package codec is the universal encoder/decoder dispatch facade. |
|
asn1
Package asn1 registers the ASN.1 DER codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package asn1 registers the ASN.1 DER codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
baseenc
Package baseenc registers the base-N codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package baseenc registers the base-N codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
bson
Package bson is BSON, MongoDB's binary document format, implemented with the standard library alone.
|
Package bson is BSON, MongoDB's binary document format, implemented with the standard library alone. |
|
cbor
Package cbor registers the CBOR codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package cbor registers the CBOR codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
csv
Package csv registers the CSV codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package csv registers the CSV codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
flatbuffers
Package flatbuffers registers the FlatBuffers codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package flatbuffers registers the FlatBuffers codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
form
Package form registers the application/x-www-form-urlencoded codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package form registers the application/x-www-form-urlencoded codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
json
Package json registers the JSON codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package json registers the JSON codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
jsonpatch
Package jsonpatch computes the structural difference between two JSON documents as RFC 6902 operations — add, remove and replace, each at an RFC 6901 JSON Pointer — with the value each operation writes and the value it replaces or removes (ADR 0143).
|
Package jsonpatch computes the structural difference between two JSON documents as RFC 6902 operations — add, remove and replace, each at an RFC 6901 JSON Pointer — with the value each operation writes and the value it replaces or removes (ADR 0143). |
|
jsonshape
Package jsonshape describes how values of a Go type look on the wire under encoding/json — the JSON kind each value takes, the members an object has and under which names, which may be missing and which may be null — for a reader to show: an API's documentation, a developer console, a schema generator (ADR 0133).
|
Package jsonshape describes how values of a Go type look on the wire under encoding/json — the JSON kind each value takes, the members an object has and under which names, which may be missing and which may be null — for a reader to show: an API's documentation, a developer console, a schema generator (ADR 0133). |
|
msgpack
Package msgpack registers the MessagePack codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package msgpack registers the MessagePack codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
multipart
Package multipart registers the multipart/form-data codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package multipart registers the multipart/form-data codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
ndjson
Package ndjson registers the NDJSON codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package ndjson registers the NDJSON codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
pem
Package pem registers the PEM codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package pem registers the PEM codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
strictjson
Package strictjson decodes exactly one JSON document into a Go value, within a byte bound, refusing what a permissive decoder lets through — and no refusal ever repeats a byte of the document.
|
Package strictjson decodes exactly one JSON document into a Go value, within a byte bound, refusing what a permissive decoder lets through — and no refusal ever repeats a byte of the document. |
|
strictjson/httpbody
Package httpbody decodes the JSON body of an HTTP request with the strict decoder of github.com/kitsunium/sdk/pkg/v1/data/codec/strictjson, adding what only an HTTP body has.
|
Package httpbody decodes the JSON body of an HTTP request with the strict decoder of github.com/kitsunium/sdk/pkg/v1/data/codec/strictjson, adding what only an HTTP body has. |
|
tlv
Package tlv registers the TLV codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package tlv registers the TLV codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
toml
Package toml registers the TOML codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package toml registers the TOML codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
xml
Package xml registers the XML codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package xml registers the XML codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
yaml
Package yaml registers the YAML codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134):
|
Package yaml registers the YAML codec with the SDK's codec registry — and no other codec — when it is imported (ADR 0134): |
|
Package docstore is the public facade for the SDK's document store: typed, keyed JSON documents with unique and multi-valued secondary indexes, kept in memory or persisted to a filesystem, every write durable before it returns.
|
Package docstore is the public facade for the SDK's document store: typed, keyed JSON documents with unique and multi-valued secondary indexes, kept in memory or persisted to a filesystem, every write durable before it returns. |
|
Package queue is the public facade for the SDK's ASYNCHRONOUS, DURABLE message queue: one process publishes work, another process picks it up later, and a crash in between loses nothing.
|
Package queue is the public facade for the SDK's ASYNCHRONOUS, DURABLE message queue: one process publishes work, another process picks it up later, and a crash in between loses nothing. |
|
Package semver orders and reads version strings under Semantic Versioning 2.0.0, written the way Go writes them — with a leading "v" — and recognises Go pseudo-versions.
|
Package semver orders and reads version strings under Semantic Versioning 2.0.0, written the way Go writes them — with a leading "v" — and recognises Go pseudo-versions. |
|
Package sql is the public facade for the SDK's relational-database domain: transaction ownership, a pool policy, a health check and a migration runner, over the standard library's database/sql.
|
Package sql is the public facade for the SDK's relational-database domain: transaction ownership, a pool policy, a health check and a migration runner, over the standard library's database/sql. |
|
Package transform compresses and decompresses bytes with the SDK's compressors, without the codec package (ADR 0014).
|
Package transform compresses and decompresses bytes with the SDK's compressors, without the codec package (ADR 0014). |
|
Package vfs is the public facade for the SDK's filesystem domain: reading stays io/fs, writing gets a contract, and publishing a file becomes one call that either replaces it completely or changes nothing at all.
|
Package vfs is the public facade for the SDK's filesystem domain: reading stays io/fs, writing gets a contract, and publishing a file becomes one call that either replaces it completely or changes nothing at all. |
Click to show internal directories.
Click to hide internal directories.