v0.35.0

Author: aDotInTheVoid

CHANGELOG.md

@@ -1,3 +1,16 @@
+<a name="v0.35.0"></a>
+# [v0.35.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.35.0) - 2025-01-24
+
+**Breaking Change**: Rename the `Path::name` field to `Path::path`, and make it
+have the entire path. This effectively reverts the [previous release](#v0.34.0),
+as it was [not possible for many consumers to
+migrate](https://github.com/rust-lang/rust/issues/135600)
+([rust#135799](https://github.com/rust-lang/rust/pull/135799)).
+
+- Format Version: 39
+- Upstream Commit: [`40e28582bb95e33f762dea75b78f6ebb5c29b836`](https://github.com/rust-lang/rust/commit/40e28582bb95e33f762dea75b78f6ebb5c29b836)
+- Diff: [v0.34.0...v0.35.0](https://github.com/aDotInTheVoid/rustdoc-types/compare/v0.34.0...v0.35.0)
+
 <a name="v0.34.0"></a>
 # [v0.34.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.34.0) - 2025-01-15
 
@@ -7,7 +20,7 @@ the full path. Users needing the full path can find it in the `Crate::paths` map
 
 No changes were made to the schema (i.e. the public api for this crate is
 unchanged), but the format version has been bumped, as this may effect consuming
-tools regardless. 
+tools regardless.
 
 - Format Version: 38
 - Upstream Commit: [`2c4aee92fa65e74f23ad7853937db8d2c4bfa6c8`](https://github.com/rust-lang/rust/commit/2c4aee92fa65e74f23ad7853937db8d2c4bfa6c8)

COMMIT.txt

@@ -1 +1 @@
-2c4aee92fa65e74f23ad7853937db8d2c4bfa6c8
+40e28582bb95e33f762dea75b78f6ebb5c29b836

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rustdoc-types"
-version = "0.34.0"
+version = "0.35.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 = 38;
+pub const FORMAT_VERSION: u32 = 39;
 
 /// The root of the emitted JSON blob.
 ///
@@ -1035,16 +1035,20 @@ pub enum Type {
 /// A type that has a simple path to it. This is the kind of type of structs, unions, enums, etc.
 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct Path {
-    /// The name of the type as declared, e.g. in
+    /// The path of the type.
+    ///
+    /// This will be the path that is *used* (not where it is defined), so
+    /// multiple `Path`s may have different values for this field even if
+    /// they all refer to the same item. e.g.
     ///
     /// ```rust
-    /// mod foo {
-    ///     struct Bar;
-    /// }
+    /// pub type Vec1 = std::vec::Vec<i32>; // path: "std::vec::Vec"
+    /// pub type Vec2 = Vec<i32>; // path: "Vec"
+    /// pub type Vec3 = std::prelude::v1::Vec<i32>; // path: "std::prelude::v1::Vec"
     /// ```
-    ///
-    /// for `foo::Bar`, this field will be `Bar`.
-    pub name: String,
+    //
+    // Example tested in ./tests/rustdoc-json/path_name.rs
+    pub path: String,
     /// The ID of the type.
     pub id: Id,
     /// Generic arguments to the type.
@@ -1098,8 +1102,7 @@ pub struct Trait {
     pub is_auto: bool,
     /// Whether the trait is marked as `unsafe`.
     pub is_unsafe: bool,
-    // FIXME(dyn_compat_renaming): Update the URL once the Reference is updated and hits stable.
-    /// Whether the trait is [dyn compatible](https://doc.rust-lang.org/reference/items/traits.html#object-safety)[^1].
+    /// Whether the trait is [dyn compatible](https://doc.rust-lang.org/reference/items/traits.html#dyn-compatibility)[^1].
     ///
     /// [^1]: Formerly known as "object safe".
     pub is_dyn_compatible: bool,