README
¶
urlencoder
Encode/decode nested data structures to/from url.Values using a
predictable dotted/recursive syntax.
Install
import "github.com/aatuh/urlencoder"
Quick start
e := urlencoder.NewURLEncoder()
vals, _ := e.Encode(map[string]any{
"user": map[string]any{
"id": 1,
"name": "Ada",
},
"tags": []string{"a", "b"},
})
// user.id=1&user.name=Ada&tags[0]=a&tags[1]=b
m, _ := e.Decode(vals)
// m["user"].(map[string]any)["name"] == "Ada"
Rules
- Keys:
a,a.b,a[0],a.mapKey. - Structs require
jsontags for field names; embedded fields are inlined. - Maps must have string keys.
- Pointers/interfaces are dereferenced when non‑nil.
Notes
- Guardrails: max recursion depth and slice size, plus basic index validation.
- Decoding uses an internal sparse slice helper and returns regular slices.
Documentation
¶
Overview ¶
Package urlcodec encodes/decodes nested data structures to/from url.Values using a predictable dotted/recursive syntax.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type URLEncoder ¶
type URLEncoder struct{}
URLEncoder encodes and decodes URL values.
func NewURLEncoder ¶
func NewURLEncoder() *URLEncoder
NewURLEncoder returns a new URLEncoder.
Returns:
- *URLEncoder: The new URLEncoder.
func (URLEncoder) Decode ¶
Decode decodes URL values and supports the following recursive URL syntax: someKey=value someStruct.field=value someSlice[0]=value someMap.key=value
Parameters:
- values: URL values
Returns:
- map[string]any: Decoded data
- error: Error
func (URLEncoder) Encode ¶
Encode encodes URL data and supports the following recursive URL syntax: someKey=value someStruct.field=value someSlice[0]=value someMap.key=value
It will return an error if a "json" tag is not found for a struct field.
Parameters:
- data: Data to encode
Returns:
- url.Values: URL values
- error: Error
Source Files