Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v0.31.0 #40

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<a name="v0.31.0"></a>
# [v0.31.0](https:/aDotInTheVoid/rustdoc-types/releases/tag/v0.31.0) - 2024-10-13

**Breaking Change**: `Id` is now a `u32` instead of a `String` ([rust#130078](https:/rust-lang/rust/pull/130078))

- Format Version: 35
- Upstream Commit: [`05c0591321f9956c1f0df4785d3737f40cffb598`](https:/rust-lang/rust/commit/05c0591321f9956c1f0df4785d3737f40cffb598)
- Diff: [v0.30.0...v0.31.0](https:/aDotInTheVoid/rustdoc-types/compare/v0.30.0...v0.31.0)

<a name="v0.30.0"></a>
# [v0.30.0](https:/aDotInTheVoid/rustdoc-types/releases/tag/v0.30.0) - 2024-09-13

Expand Down
2 changes: 1 addition & 1 deletion COMMIT.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
f2696ab4d3095bb6ad6197e55855ebdf00f50b80
05c0591321f9956c1f0df4785d3737f40cffb598
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rustdoc-types"
version = "0.30.0"
version = "0.31.0"
edition = "2018"
license = "MIT OR Apache-2.0"
description = "Types for rustdoc's json output"
Expand Down
10 changes: 5 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,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 = 34;
pub const FORMAT_VERSION: u32 = 35;

/// The root of the emitted JSON blob.
///
Expand Down Expand Up @@ -296,9 +296,9 @@ 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, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
// FIXME(aDotInTheVoid): Consider making this non-public in rustdoc-types.
pub struct Id(pub String);
pub struct Id(pub u32);

/// The fundamental kind of an item. Unlike [`ItemEnum`], this does not carry any aditional info.
///
Expand Down Expand Up @@ -677,7 +677,7 @@ pub struct FunctionHeader {
/// on unwinding for more info.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Abi {
// We only have a concrete listing here for stable ABI's because their are so many
// We only have a concrete listing here for stable ABI's because there are so many
// See rustc_ast_passes::feature_gate::PostExpansionVisitor::check_abi for the list
/// The default ABI, but that can also be written explicitly with `extern "Rust"`.
Rust,
Expand Down Expand Up @@ -1168,7 +1168,7 @@ pub struct ProcMacro {
pub kind: MacroKind,
/// Helper attributes defined by a macro to be used inside it.
///
/// Defined only for attribute & derive macros.
/// Defined only for derive macros.
///
/// E.g. the [`Default`] derive macro defines a `#[default]` helper attribute so that one can
/// do:
Expand Down