public-api 0.33.1

List and diff the public API of Rust library crates. Relies on rustdoc JSON output from the nightly toolchain.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

# `public-api` changelog

## v0.33.1
* Fixup 'Avoid textual API diff when changing a trait impl to an auto-derived impl.'

## v0.33.0
* Avoid textual API diff when changing a trait impl to an auto-derived impl.

## v0.32.0
* Support `nightly-2023-08-25` and later
* Remove all deprecated API

## v0.31.0
* Change rendering of `impl` items to include generic args of the implementor
* Ignore `!` when sorting `impl`s to make `Send` and `Sync` order stable

## v0.30.0
* Support `nightly-2023-05-24` and later

## v0.29.1
* Prevent infinite RAM usage by hardening recursion detection

## v0.29.0
* Remove the `public-api` bin. Use `cargo public-api` instead.

## v0.28.0
* Rename `MINIMUM_NIGHTLY_VERSION` to `MINIMUM_NIGHTLY_RUST_VERSION` for clarity
* Deprecate `PublicApi::from_rustdoc_json()`. Use `public_api::Builder::from_rustdoc_json()` instead.
* Deprecate `Options`. Use `public_api::Builder` methods instead.

## v0.27.3
* Bump deps

## v0.27.2
* Bump deps

## v0.27.1
* Deprecate `PublicApi::from_rustdoc_json_str()`

## v0.27.0
* Make `Eq` and `Hash` for `PublicItem` only take tokens into account, to make diffing insensitive to internal data that has no bearing on public API surface of a crate
* Remove `Ord` and `PartialOrd` impls of `PublicItem` and `ChangedPublicItem`. Use `PublicItem::grouping_cmp` and `ChangedPublicItem::grouping_cmp` instead.
* Rename `MINIMUM_RUSTDOC_JSON_VERSION` to `MINIMUM_NIGHTLY_VERSION` for clarity

## v0.26.0
* Put auto-derived impls (`Clone`, `Debug`, etc) in a separate group, right after normal `impl`s
* Remove deprecated `Options::with_blanket_implementations`
* Split `Options::simplified` into `Options::omit_auto_trait_impls` and `Options::omit_blanket_impls`

## v0.25.0
* Get rid of `enum variant` and `struct field` prefixes in rendered items
* Group impl blocks together with their respective functions
* Bump all deps

## v0.24.1
* Make `PublicApi` implement `Display` to get `.to_string()`. All items in one big multi-line `String`.

## v0.22.0
* Remove deprecated `fn public_api_from_rustdoc_json_str()`

## v0.21.0
* Rename `PublicItemsDiff` to `PublicApiDiff`
* Make `PublicApiDiff::between(...)` take `PublicApi`s instead of `Vec<PublicItem>`s
* Hide `PublicApi::items` behind `PublicApi::items()` iterator
* Add `PublicApi::from_rustdoc_json(...)` that takes a rustdoc JSON file `Path`

## v0.20.1
* Allow to specify `--target-dir` when building rustdoc JSON

## v0.20.0
* deprecate `public_api_from_rustdoc_json_str` and replace with method on `PublicApi`
* move `rustdoc_json::build` into a struct fn `BuildOptions::build`

## v0.15.0
* Introduce `PublicApi` struct

## v0.12.4
* Add `PublicItemsDiff::is_empty()`

## v0.12.0
* Add `Token::Annotation`

## v0.11.5
* impl `Hash` for `PublicItem`

## v0.10.0
* Remove `TokenStream`

## v0.9.0
* Rename project from `public_items` to `public-api` and add `Token`s