serde-rs / json

Strongly typed JSON library for Rust
Apache License 2.0
4.9k stars 558 forks source link

Document standards conformance #397

Open sanmai-NL opened 6 years ago

sanmai-NL commented 6 years ago

JSON standards have been updated.

Current

It’s not documented to which standard this crate aims to conform.

Expected

It’s documented in the README as well as API docs to which standard this crate aims to conform.

dtolnay commented 7 months ago

8259 contains one new sentence: “JSON text exchanged between systems that are not part of a closed ecosystem MUST be encoded using UTF-8 [RFC3629].”

The difference between these standards is orthogonal to serde_json, right? Serde_json is not in control of how you exchange serialized JSON between systems, and as part of deserializing you do not tell serde_json whether the input came from the same system, from a different system within a closed ecosystem, or a different system not within a closed ecosystem.

If so, I don't think we need to document a specific choice of standard.

But for to_vec and to_writer we can document that they are guaranteed to produce UTF-8 bytes.