Liking cljdoc? Tell your friends :D
ol.sfv
RFC 9651 Structured Field Values for HTTP.
See the project website for info on motivation and design: https://github.com/outskirtslabs/sfv
This ns provides parsing and serialization of Structured Fields containing Items, Lists, and Dictionaries with Parameters. Returns precise AST representations that round-trip byte-for-byte with RFC 9651 strings.
Primary functions: parse, parse-item, parse-list, parse-dict,
serialize
Conventions
s-or-bytes: Input string or byte array (decoded as ascii) containing HTTP field valuefield-type: One of:item,:list, or:dictspecifying the top-level structure:bare: The raw value within an Item (Integer, Decimal, String, Token, Byte Sequence, Boolean, Date, or Display String)
Primitive Types
Each Item's :bare is one of these RFC 9651 types:
| SFV type | Header | AST example | Clojure type (:value) |
|---|---|---|---|
| Integer | 42, -17, 999999999999999 | {:type :integer :value 1618884473} | long |
| Decimal | 3.14, -0.5 | {:type :decimal :value 3.14M} | BigDecimal |
| String | " hello world " | {:type :string :value " hello "} | java.lang.String |
| Token | simple-token | {:type :token :value " simple-token "} | String |
| Byte Sequence | :SGVsbG8=: | {:type :bytes :value <platform bytes>} | byte[] |
| Boolean | ?1 / ?0 | {:type :boolean :value true} | true / false |
| Date | @1659578233 | {:type :date :value 1659578233} | epoch seconds as long |
| Display String | %" Gr%c3%bc%c3%9fe " | {:type :display :value " Grüße "} | String (percent-decoded, validated) |
RFC 9651 Structured Field Values for HTTP.
See the project website for info on motivation and design:
<https://github.com/outskirtslabs/sfv>
This ns provides parsing and serialization of Structured Fields containing
Items, Lists, and Dictionaries with Parameters. Returns precise AST
representations that round-trip byte-for-byte with RFC 9651 strings.
Primary functions: [[parse]], [[parse-item]], [[parse-list]], [[parse-dict]],
[[serialize]]
## Conventions
- `s-or-bytes`: Input string or byte array (decoded as ascii) containing HTTP field value
- `field-type`: One of `:item`, `:list`, or `:dict` specifying the top-level structure
- `:bare`: The raw value within an Item (Integer, Decimal, String, Token, Byte Sequence, Boolean, Date, or Display String)
## Primitive Types
Each Item's `:bare` is one of these RFC 9651 types:
| SFV type | Header | AST example | Clojure type (`:value`) |
|----------------|--------------------------------|--------------------------------------------|---------------------------------------|
| Integer | `42`, `-17`, `999999999999999` | `{:type :integer :value 1618884473}` | `long` |
| Decimal | `3.14`, `-0.5` | `{:type :decimal :value 3.14M}` | `BigDecimal` |
| String | `" hello world "` | `{:type :string :value " hello "}` | `java.lang.String` |
| Token | `simple-token` | `{:type :token :value " simple-token "}` | `String` |
| Byte Sequence | `:SGVsbG8=:` | `{:type :bytes :value <platform bytes>}` | `byte[]` |
| Boolean | `?1` / `?0` | `{:type :boolean :value true}` | `true` / `false` |
| Date | `@1659578233` | `{:type :date :value 1659578233}` | epoch seconds as `long` |
| Display String | `%" Gr%c3%bc%c3%9fe "` | `{:type :display :value " Grüße "}` | `String` (percent-decoded, validated) |
- bool
- bool?
- bytes
- bytes?
- date
- date?
- decimal
- decimal?
- dict->pairs
- dict-get
- dict-keys
- dstring
- dstring?
- flag
- flag?
- inner-items
- inner-list
- inner-list?
- inner-params
- integer
- integer?
- item
- item-bare
- item-params
- item?
- list-members
- param-get
- param-keys
- params
- parse
- parse-dict
- parse-item
- parse-list
- serialize
- sf-dict
- sf-dict?
- sf-list
- sf-list?
- string
- string?
- token
- token?
ol.sfv.impl
- alpha?
- ascii-string
- bool
- bool?
- bytes
- bytes?
- combine-field-lines
- consume-char
- date
- date?
- decimal
- decimal?
- decode-percent-sequence
- dict->pairs
- dict-get
- dict-keys
- digit?
- dstring
- dstring?
- eof?
- flag
- flag?
- hex-digit-value
- init-ctx
- inner-items
- inner-list
- inner-list?
- inner-params
- integer
- integer?
- item
- item-bare
- item-params
- item?
- lc-hexdig?
- lcalpha?
- list-members
- param-get
- param-keys
- params
- parse
- parse-bare-item
- parse-byte-sequence
- parse-date
- parse-dict
- parse-display-string
- parse-error
- parse-inner-list
- parse-integer-or-decimal
- parse-item
- parse-item-or-inner-list
- parse-key
- parse-list
- parse-list-members
- parse-parameters
- parse-sfv-boolean
- parse-string
- parse-token
- peek-char
- serialize
- serialize-bare-item
- serialize-boolean
- serialize-byte-sequence
- serialize-date
- serialize-decimal
- serialize-dict
- serialize-display-string
- serialize-inner-list
- serialize-integer
- serialize-item
- serialize-key
- serialize-list
- serialize-parameters
- serialize-string
- serialize-token
- sf-dict
- sf-dict?
- sf-list
- sf-list?
- skip-ows
- skip-sp
- string
- string?
- tchar?
- token
- token-char?
- token?
- validate-field-line
cljdoc builds & hosts documentation for Clojure/Script libraries
Keyboard shortcuts
× close| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |