structured_fields - v1.0.0

structured_fields/serializer

Values

serialize_dictionary

</> 
pub fn serialize_dictionary(
  pairs: List(#(String, types.Element)),
) -> String

Serializes a Structured Fields Dictionary to a header string (RFC 9651 §4.1.2).

Entries are joined with ", ". When a value is Item(Boolean(True), params) the =value part is omitted (bare-flag shorthand). An empty list produces an empty string.

Example:

serialize_dictionary([#("a", Item(Boolean(True), [])), #("b", Item(Integer(2), []))])
// -> "a, b=2"

serialize_item

</> 
pub fn serialize_item(value: types.Element) -> String

Serializes a single Structured Fields Item or InnerList to a string (RFC 9651 §4.1.3).

The bare item value is serialized first, followed by any parameters. For an InnerList the members are space-separated and wrapped in parentheses.

Example:

serialize_item(Item(BareString("hello"), [Parameter("charset", Token("utf-8"))]))
// -> "\"hello\";charset=utf-8"

serialize_list

</> 
pub fn serialize_list(value: List(types.Element)) -> String

Serializes a Structured Fields List to a header string (RFC 9651 §4.1.1).

Members are joined with ", ". An empty list produces an empty string.

Example:

serialize_list([Item(Token("a"), []), Item(Integer(1), [])])
// -> "a, 1"

serialize_parameters

</> 
pub fn serialize_parameters(
  params: List(types.Parameter),
) -> String

Serializes a parameter list to its wire representation (RFC 9651 §4.1.3.2).

Each parameter is prefixed with ;. When the value is Boolean(True) the =value part is omitted. An empty list produces an empty string.

Example:

serialize_parameters([Parameter("q", Decimal(0.5)), Parameter("ext", Boolean(True))])
// -> ";q=0.5;ext"
✨ Search Document