nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-24 07:44:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
8236f63aba
rust/src/rustdoc-json-types
History
Luca Palmieri cd7688bd30 Verify that ItemEnum can be serialized and then deserialized using bincode
2023-05-22 18:26:20 +01:00
..
Cargo.toml Verify that ItemEnum can be serialized and then deserialized using bincode 2023-05-22 18:26:20 +01:00
lib.rs Serialize all enums as externally tagged to guarantee compatibility with binary formats such as bincode or postcard 2023-05-22 18:22:08 +01:00
README.md Fix README typo 2021-01-28 11:15:43 -05:00
tests.rs Verify that ItemEnum can be serialized and then deserialized using bincode 2023-05-22 18:26:20 +01:00

README.md

Rustdoc JSON Types

This crate exposes the Rustdoc JSON API as a set of types with serde implementations. These types are part of the public interface of the rustdoc JSON output, and making them their own crate allows them to be versioned and distributed without having to depend on any rustc/rustdoc internals. This way, consumers can rely on this crate for both documentation of the output, and as a way to read the output easily, and its versioning is intended to follow semver guarantees about the version of the format. JSON format X will always be compatible with rustdoc-json-types version N.

Currently, this crate is only used by rustdoc itself. Upon the stabilization of rustdoc-json, it may be distributed separately for consumers of the API.