structured_fields - v1.0.0

structured_fields/types

Types

BareItem

</>

The bare value of a structured-field item, without any parameters.

The variants map to the seven item types defined in RFC 9651:

VariantWire format example
BareString"hello"
Boolean?1 / ?0
ByteSequence:aGVsbG8=:
Integer42
Decimal3.14
Tokentext/html
DisplayString%"caf%C3%A9"
pub type BareItem {
  BareString(String)
  Boolean(Bool)
  ByteSequence(BitArray)
  Integer(Int)
  Decimal(Float)
  Token(String)
  DisplayString(String)
}

Constructors 

  • BareString(String)

    A UTF-8 string delimited by double quotes on the wire.

  • Boolean(Bool)

    A boolean: ?1 for True, ?0 for False.

  • ByteSequence(BitArray)

    Arbitrary bytes encoded as standard base64 between colons.

  • Integer(Int)

    A signed integer in the range −999,999,999,999,999 to 999,999,999,999,999.

  • Decimal(Float)

    A decimal with up to three fractional digits.

  • Token(String)

    An unquoted token made up of a restricted set of ASCII characters.

  • DisplayString(String)

    A UTF-8 string with percent-encoding for non-printable bytes, prefixed %".

Element

</>

A member of a Structured Fields List or Dictionary.

An Item carries a single BareItem together with zero or more Parameters. An InnerList is a parenthesized sequence of Items (no nesting of inner lists is allowed) with its own Parameters.

pub type Element {
  Item(value: BareItem, parameters: List(Parameter))
  InnerList(value: List(Element), parameters: List(Parameter))
}

Constructors 

  • Item(value: BareItem, parameters: List(Parameter))

    A single structured-field item with an optional parameter list.

  • InnerList(value: List(Element), parameters: List(Parameter))

    A parenthesized list of items with an optional parameter list.

Parameter

</>

A name-value pair attached to an Item or InnerList.

Parameter names follow the same rules as dictionary keys: they must start with a lowercase letter or * and may contain lowercase letters, digits, _, -, ., and *. When the value is Boolean(True) the =value part is omitted during serialization (bare-flag form).

pub type Parameter {
  Parameter(name: String, value: BareItem)
}

Constructors 

  • Parameter(name: String, value: BareItem)
✨ Search Document