#moon-sfv

#Why

#Features

#Standards Compliance

• HTTPWG Parsing Test Vectors: 1,591 / 1,591 passed
  • Mandatory vectors: 1,585 / 1,585 passed (100%)
  • Optional (can_fail) vectors: 6 / 6 supported and passed (100% strict verification)
  • Verification method: Parsed output is strictly compared for semantic equality (assert_eq) against the official expected data structures and verified for canonical serialization matching with zero silent-pass fallbacks.
• HTTPWG Serialization Test Vectors: 544 / 544 passed (100%)
• Internal Unit Tests: 46 / 46 passed (100%)
• Total Test Suite: 2,181 / 2,181 passed (100%)
• Skipped / Unsupported: 0

#Installation

moon add Sam-Hui-dot/moon-sfv

import {
  "Sam-Hui-dot/moon-sfv" @sfv,
}

#Usage

#1. Item

let input = "example;secure;level=2"

match @sfv.parse_item(input) {
  Ok(item) => {
    // item.value is BareItem::SfToken("example")
    // item.parameters has { "secure": true, "level": 2 }
    match @sfv.serialize_item(item) {
      Ok(canonical) => println(canonical) // "example;secure;level=2"
      Err(_) => println("Serialization failed")
    }
  }
  Err(_) => println("Parsing failed")
}

#2. List

let input = "text/html;q=1.0, (\"gzip\" \"br\");level=9"

match @sfv.parse_list(input) {
  Ok(list) => {
    // list contains Item and InnerList members
    match @sfv.serialize_list(list) {
      Ok(canonical) => println(canonical)
      Err(_) => println("Serialization failed")
    }
  }
  Err(_) => println("Parsing failed")
}

#3. Dictionary

let input = "en=\"Applepie\", da=:w4ZibGV0w6ZydGUK:, active, flags=(x y)"

match @sfv.parse_dictionary(input) {
  Ok(dict) => {
    // dict contains ordered key-value pairs with boolean shorthand support
    match @sfv.serialize_dictionary(dict) {
      Ok(canonical) => println(canonical)
      Err(_) => println("Serialization failed")
    }
  }
  Err(_) => println("Parsing failed")
}

#API Reference

#Core Types

pub(all) enum BareItem {
  SfInteger(Int64)
  SfDecimal(Double)
  SfString(String)
  SfToken(String)
  SfByteSequence(Bytes)
  SfBoolean(Bool)
  SfDate(Int64)
  SfDisplayString(String)
} derive(Eq, Debug)

pub(all) struct Parameter {
  key : String
  value : BareItem
} derive(Eq, Debug)

pub(all) struct Item {
  value : BareItem
  parameters : Array[Parameter]
} derive(Eq, Debug)

pub(all) struct InnerList {
  items : Array[Item]
  parameters : Array[Parameter]
} derive(Eq, Debug)

pub(all) enum ListMember {
  Item(Item)
  InnerList(InnerList)
} derive(Eq, Debug)

pub(all) struct DictionaryMember {
  key : String
  value : ListMember
} derive(Eq, Debug)

#Parsing and Serialization Functions

pub fn parse_item(String) -> Result[Item, ParseError]
pub fn serialize_item(Item) -> Result[String, SerializeError]

pub fn parse_list(String) -> Result[Array[ListMember], ParseError]
pub fn serialize_list(Array[ListMember]) -> Result[String, SerializeError]

pub fn parse_dictionary(String) -> Result[Array[DictionaryMember], ParseError]
pub fn serialize_dictionary(Array[DictionaryMember]) -> Result[String, SerializeError]

pub fn base64_encode(Bytes) -> String
pub fn base64_decode(String) -> Bytes?

pub fn string_to_utf8_bytes(String) -> Array[Byte]
pub fn utf8_bytes_to_string(Array[Byte]) -> String?

#Testing

moon check --deny-warn
moon test
moon fmt --check

moon run examples/main

#Status

#License and Attribution

• moon-sfv is licensed under the MIT License.
• Vendored test vectors in test-vectors/structured-field-tests are subject to the IETF Trust BSD 3-Clause License (Copyright © 2018- IETF Trust and the authors).