Skip to main content

Crate vr_jcs

Crate vr_jcs 

Source
Expand description

§vr-jcs

RFC 8785 JSON Canonicalization Scheme (JCS) for Rust.

Produces canonical JSON suitable for deterministic digest computation, content hashing, and stable serialization boundaries. Implements the RFC 8785 rules that materially affect wire compatibility:

  • UTF-16 code-unit sorting for object property names
  • ECMAScript-compatible primitive serialization
  • UTF-8 output without insignificant whitespace
  • duplicate-property rejection on raw JSON parse paths
  • I-JSON string / number validation

§API

§Usage

use vr_jcs::to_canon_string;
use serde::Serialize;

#[derive(Serialize)]
struct Receipt {
    z_field: u64,
    a_field: u64,
}

let receipt = Receipt { z_field: 1, a_field: 2 };
let json = to_canon_string(&receipt).expect("serialization");
assert_eq!(json, r#"{"a_field":2,"z_field":1}"#);

Enums§

JcsError
Error type for canonical JSON operations.

Functions§

canonicalize
Recursively sort all object keys in a JSON value for canonical representation.
to_canon_bytes
Serialize any Serialize type to canonical JSON bytes.
to_canon_bytes_from_slice
Parse raw JSON text and return canonical JSON bytes.
to_canon_string
Serialize any Serialize type to a canonical JSON string.
to_canon_string_from_str
Parse raw JSON text and return a canonical JSON string.