Skip to content

Commit 1e078f7

Browse files
committed
1 parent 7023af7 commit 1e078f7

File tree

4 files changed

+16
-13
lines changed

4 files changed

+16
-13
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<a name="v0.19.0"></a>
2+
# [v0.19.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.19.0) - 2022-11-21
3+
- Format Version: 23
4+
- Upstream Commit: [`30b7e44a3cabe1c21129253da54b21193f65ebe0`](https://github.com/rust-lang/rust/commit/30b7e44a3cabe1c21129253da54b21193f65ebe0)
5+
- Diff: [v0.19.0...v0.18.0](https://github.com/aDotInTheVoid/rustdoc-types/compare/v0.18.0...v0.19.0)
6+
17
<a name="v0.18.0"></a>
28
# [v0.18.0](https://github.com/aDotInTheVoid/rustdoc-types/releases/tag/v0.18.0) - 2022-09-27
39
- Format Version: 22

COMMIT.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
aac7429c17aa558fbd9fb0be093e7bd9ccc73972
1+
30b7e44a3cabe1c21129253da54b21193f65ebe0

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rustdoc-types"
3-
version = "0.18.0"
3+
version = "0.19.0"
44
authors = ["Nixon Enraght-Moony <[email protected]>", "The Rust Project Developers"]
55
edition = "2018"
66
license = "MIT OR Apache-2.0"

src/lib.rs

+8-11
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use std::path::PathBuf;
99
use serde::{Deserialize, Serialize};
1010

1111
/// rustdoc format-version.
12-
pub const FORMAT_VERSION: u32 = 22;
12+
pub const FORMAT_VERSION: u32 = 23;
1313

1414
/// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information
1515
/// about the language items in the local crate, as well as info about external items to allow
@@ -51,6 +51,11 @@ pub struct ItemSummary {
5151
pub crate_id: u32,
5252
/// The list of path components for the fully qualified path of this item (e.g.
5353
/// `["std", "io", "lazy", "Lazy"]` for `std::io::lazy::Lazy`).
54+
///
55+
/// Note that items can appear in multiple paths, and the one chosen is implementation
56+
/// defined. Currently, this is the full path to where the item was defined. Eg
57+
/// [`String`] is currently `["alloc", "string", "String"]` and [`HashMap`] is
58+
/// `["std", "collections", "hash", "map", "HashMap"]`, but this is subject to change.
5459
pub path: Vec<String>,
5560
/// Whether this item is a struct, trait, macro, etc.
5661
pub kind: ItemKind,
@@ -205,7 +210,6 @@ pub enum ItemKind {
205210
Constant,
206211
Trait,
207212
TraitAlias,
208-
Method,
209213
Impl,
210214
Static,
211215
ForeignType,
@@ -238,7 +242,6 @@ pub enum ItemEnum {
238242

239243
Trait(Trait),
240244
TraitAlias(TraitAlias),
241-
Method(Method),
242245
Impl(Impl),
243246

244247
Typedef(Typedef),
@@ -346,7 +349,7 @@ pub enum Variant {
346349
/// A variant with unnamed fields.
347350
///
348351
/// Unlike most of json, `#[doc(hidden)]` fields will be given as `None`
349-
/// instead of being ommited, because order matters.
352+
/// instead of being omitted, because order matters.
350353
///
351354
/// ```rust
352355
/// enum Demo {
@@ -410,18 +413,12 @@ pub enum Abi {
410413
Other(String),
411414
}
412415

416+
/// Represents a function (including methods and other associated functions)
413417
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
414418
pub struct Function {
415419
pub decl: FnDecl,
416420
pub generics: Generics,
417421
pub header: Header,
418-
}
419-
420-
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
421-
pub struct Method {
422-
pub decl: FnDecl,
423-
pub generics: Generics,
424-
pub header: Header,
425422
pub has_body: bool,
426423
}
427424

0 commit comments

Comments
 (0)