v0.46.0

Author: aDotInTheVoid

CHANGELOG.md

@@ -1,3 +1,25 @@
+<a name="v0.46.0"></a>
+# [v0.46.0](https://github.com/rust-lang/rustdoc-types/releases/tag/v0.46.0) - 2025-06-03
+
+**Versioning Change**: The crate version now corresponds to the `FORMAT_VERSION` constant.
+([#24](https://github.com/rust-lang/rustdoc-types/issues/24))
+
+**Feature**: `Id` now implments `Ord` and `PartialOrd`, making it usable as a
+key in a `BTreeMap`
+([rust#141898](https://github.com/rust-lang/rust/pull/141898)).
+
+**Breaking Change(??)**: `Item::attrs` now always includes `#[repr]`. No changes
+were made to the schema but the format version has been bumped, as this may
+effect consuming tools regardless
+([rust#141126](https://github.com/rust-lang/rust/pull/141126)).
+
+**Documentation Improvements**: Fixed some false docs
+([rust#141364](https://github.com/rust-lang/rust/pull/141364)).
+
+- Format Version: 46
+- Upstream Commit: [`6be3c3ceb7351677999c661dfba0110992b37132`](https://github.com/rust-lang/rust/commit/6be3c3ceb7351677999c661dfba0110992b37132)
+- Diff: [v0.41.0...v0.46.0](https://github.com/rust-lang/rustdoc-types/compare/v0.41.0...v0.46.0)
+
 <a name="v0.41.0"></a>
 # [v0.41.0](https://github.com/rust-lang/rustdoc-types/releases/tag/v0.41.0) - 2025-04-20
 

COMMIT.txt

@@ -1 +1 @@
-076016d55afdf760c7e30e23c5df8f0c079cd85b
+6be3c3ceb7351677999c661dfba0110992b37132

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rustdoc-types"
-version = "0.41.0"
+version = "0.46.0"
 edition = "2018"
 license = "MIT OR Apache-2.0"
 description = "Types for rustdoc's json output"

src/lib.rs

@@ -29,7 +29,7 @@ use serde::{Deserialize, Serialize};
 /// This integer is incremented with every breaking change to the API,
 /// and is returned along with the JSON blob as [`Crate::format_version`].
 /// Consuming code should assert that this value matches the format version(s) that it supports.
-pub const FORMAT_VERSION: u32 = 45;
+pub const FORMAT_VERSION: u32 = 46;
 
 /// The root of the emitted JSON blob.
 ///
@@ -179,19 +179,13 @@ pub struct Item {
     ///
     /// Does not include `#[deprecated]` attributes: see the [`Self::deprecation`] field instead.
     ///
-    /// Some attributes appear in pretty-printed Rust form, regardless of their formatting
+    /// Attributes appear in pretty-printed Rust form, regardless of their formatting
     /// in the original source code. For example:
     /// - `#[non_exhaustive]` and `#[must_use]` are represented as themselves.
     /// - `#[no_mangle]` and `#[export_name]` are also represented as themselves.
     /// - `#[repr(C)]` and other reprs also appear as themselves,
     ///   though potentially with a different order: e.g. `repr(i8, C)` may become `repr(C, i8)`.
     ///   Multiple repr attributes on the same item may be combined into an equivalent single attr.
-    ///
-    /// Other attributes may appear debug-printed. For example:
-    /// - `#[inline]` becomes something similar to `#[attr="Inline(Hint)"]`.
-    ///
-    /// As an internal implementation detail subject to change, this debug-printing format
-    /// is currently equivalent to the HIR pretty-printing of parsed attributes.
     pub attrs: Vec<String>,
     /// Information about the item’s deprecation, if present.
     pub deprecation: Option<Deprecation>,
@@ -393,7 +387,7 @@ pub enum AssocItemConstraintKind {
 /// Rustdoc makes no guarantees about the inner value of Id's. Applications
 /// should treat them as opaque keys to lookup items, and avoid attempting
 /// to parse them, or otherwise depend on any implementation details.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
 // FIXME(aDotInTheVoid): Consider making this non-public in rustdoc-types.
 pub struct Id(pub u32);