Fix and unify docs of bufread and read types.
#375
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- fix wrong docs of `bufread::GzDecoder`, `bufread::GzEncoder`, `bufread::MultiGzDecoder` - make the types of inner reader and exported trait explicit. - explicit state the pull model: user initialize the read, then data is read from the underlying stream.
Byron
approved these changes
Sep 11, 2023
bors
added a commit
to rust-lang/cargo
that referenced
this pull request
Nov 1, 2023
chore(deps): update compatible [](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [base64](https://togithub.com/marshallpierce/rust-base64) | workspace.dependencies | patch | `0.21.4` -> `0.21.5` | | [cargo_metadata](https://togithub.com/oli-obk/cargo_metadata) | workspace.dependencies | patch | `0.18.0` -> `0.18.1` | | [clap](https://togithub.com/clap-rs/clap) | workspace.dependencies | patch | `4.4.6` -> `4.4.7` | | [flate2](https://togithub.com/rust-lang/flate2-rs) | workspace.dependencies | patch | `1.0.27` -> `1.0.28` | | [jobserver](https://togithub.com/alexcrichton/jobserver-rs) | workspace.dependencies | patch | `0.1.26` -> `0.1.27` | | [libc](https://togithub.com/rust-lang/libc) | workspace.dependencies | patch | `0.2.148` -> `0.2.149` | | [serde](https://serde.rs) ([source](https://togithub.com/serde-rs/serde)) | workspace.dependencies | patch | `1.0.188` -> `1.0.190` | | [serde_json](https://togithub.com/serde-rs/json) | workspace.dependencies | patch | `1.0.107` -> `1.0.108` | | [snapbox](https://togithub.com/assert-rs/trycmd/tree/main/crates/snapbox) ([source](https://togithub.com/assert-rs/trycmd)) | workspace.dependencies | patch | `0.4.13` -> `0.4.14` | | [syn](https://togithub.com/dtolnay/syn) | workspace.dependencies | patch | `2.0.37` -> `2.0.38` | | [tempfile](https://stebalien.com/projects/tempfile-rs/) ([source](https://togithub.com/Stebalien/tempfile)) | workspace.dependencies | patch | `3.8.0` -> `3.8.1` | | [thiserror](https://togithub.com/dtolnay/thiserror) | workspace.dependencies | patch | `1.0.49` -> `1.0.50` | | [toml](https://togithub.com/toml-rs/toml) | workspace.dependencies | patch | `0.8.2` -> `0.8.6` | | [tracing](https://tokio.rs) ([source](https://togithub.com/tokio-rs/tracing)) | workspace.dependencies | patch | `0.1.37` -> `0.1.40` | --- ### Release Notes <details> <summary>marshallpierce/rust-base64 (base64)</summary> ### [`v0.21.5`](https://togithub.com/marshallpierce/rust-base64/blob/HEAD/RELEASE-NOTES.md#0215) [Compare Source](https://togithub.com/marshallpierce/rust-base64/compare/v0.21.4...v0.21.5) - Add `Debug` and `Clone` impls for the general purpose Engine </details> <details> <summary>oli-obk/cargo_metadata (cargo_metadata)</summary> ### [`v0.18.1`](https://togithub.com/oli-obk/cargo_metadata/compare/0.18.0...0.18.1) [Compare Source](https://togithub.com/oli-obk/cargo_metadata/compare/0.18.0...0.18.1) </details> <details> <summary>clap-rs/clap (clap)</summary> ### [`v4.4.7`](https://togithub.com/clap-rs/clap/blob/HEAD/CHANGELOG.md#447---2023-10-24) [Compare Source](https://togithub.com/clap-rs/clap/compare/v4.4.6...v4.4.7) ##### Performance - Reduced code size </details> <details> <summary>rust-lang/flate2-rs (flate2)</summary> ### [`v1.0.28`](https://togithub.com/rust-lang/flate2-rs/releases/tag/1.0.28) [Compare Source](https://togithub.com/rust-lang/flate2-rs/compare/1.0.27...1.0.28) #### What's Changed - Use explicit Default for GzHeaderState enum by [`@​jongiddy](https://togithub.com/jongiddy)` in [rust-lang/flate2-rs#371 - Fix spare capacity handling by [`@​anforowicz](https://togithub.com/anforowicz)` in [rust-lang/flate2-rs#373 - Fix and unify docs of `bufread` and `read` types. by [`@​georeth](https://togithub.com/georeth)` in [rust-lang/flate2-rs#375 - Reset StreamWrapper after calling mz_inflate / mz_deflate by [`@​Manishearth](https://togithub.com/Manishearth)` in [rust-lang/flate2-rs#380 - prepare next patch-release by [`@​Byron](https://togithub.com/Byron)` in [rust-lang/flate2-rs#378 #### New Contributors - [`@​anforowicz](https://togithub.com/anforowicz)` made their first contribution in [rust-lang/flate2-rs#373 - [`@​georeth](https://togithub.com/georeth)` made their first contribution in [rust-lang/flate2-rs#375 - [`@​Manishearth](https://togithub.com/Manishearth)` made their first contribution in [rust-lang/flate2-rs#380 **Full Changelog**: rust-lang/flate2-rs@1.0.27...1.0.28 </details> <details> <summary>rust-lang/libc (libc)</summary> ### [`v0.2.149`](https://togithub.com/rust-lang/libc/releases/tag/0.2.149) [Compare Source](https://togithub.com/rust-lang/libc/compare/0.2.148...0.2.149) #### What's Changed - libc 0.2.148 by [`@​joshtriplett](https://togithub.com/joshtriplett)` in [rust-lang/libc#3351 - update libc-test and its libc dependency to 0.2.148 by [`@​chenx97](https://togithub.com/chenx97)` in [rust-lang/libc#3314 - Disable 1.13 CI by [`@​JohnTitor](https://togithub.com/JohnTitor)` in [rust-lang/libc#3358 - Add teeos libc by [`@​Sword-Destiny](https://togithub.com/Sword-Destiny)` in [rust-lang/libc#3333 - Added SIOCSIFNAME by [`@​Brijeshkrishna](https://togithub.com/Brijeshkrishna)` in [rust-lang/libc#3354 - copyfile apple api update by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3346 - Hermit updates by [`@​mkroening](https://togithub.com/mkroening)` in [rust-lang/libc#3348 - Add the LoongArch64 HWCAP values by [`@​heiher](https://togithub.com/heiher)` in [rust-lang/libc#3344 - Add F_PUNCHHOLE and fpunchhole_t by [`@​anacrolix](https://togithub.com/anacrolix)` in [rust-lang/libc#3337 - Fix compatibility with Emscripten >= 3.1.44 by [`@​kleisauke](https://togithub.com/kleisauke)` in [rust-lang/libc#3308 - freebsd adding few mmap constants related to page alignment by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3326 - Redox pthreads by [`@​4lDO2](https://togithub.com/4lDO2)` in [rust-lang/libc#3347 - linux MADV_COLLAPSE addition by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3340 - android adding few more pthread api calls. by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3288 - Declare `pthread_attr_setguardsize` and `pthread_attr_getstacksize`. by [`@​sunfishcode](https://togithub.com/sunfishcode)` in [rust-lang/libc#3330 - Add missing PS Vita definitions, fix some unused ones by [`@​pheki](https://togithub.com/pheki)` in [rust-lang/libc#3284 - Drop `armv7-apple-ios` target support by [`@​JohnTitor](https://togithub.com/JohnTitor)` in [rust-lang/libc#3362 - backtrace definitions and support for getmntinfo and getvfsstat by [`@​0323pin](https://togithub.com/0323pin)` in [rust-lang/libc#3368 - apple fcntl update. by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3365 - Added socketpair and pipe2 for Vita target by [`@​nikarh](https://togithub.com/nikarh)` in [rust-lang/libc#3366 - Added additional Ethernet Protocol Ids for fuchsia by [`@​w1redch4d](https://togithub.com/w1redch4d)` in [rust-lang/libc#3332 - timerfd api for freebsd 14. by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3341 - haiku adding pthread GNU part by [`@​devnexen](https://togithub.com/devnexen)` in [rust-lang/libc#3364 - add execveat for glibc by [`@​SteveLauC](https://togithub.com/SteveLauC)` in [rust-lang/libc#3372 - added support for GNU/Hurd by [`@​Vtewari2311](https://togithub.com/Vtewari2311)` in [rust-lang/libc#3325 - Fix apple tvos support by [`@​lcruz99](https://togithub.com/lcruz99)` in [rust-lang/libc#3370 - Remove deprecation from SA_ONSTACK; fix hexagon-unknown-linux-musl by [`@​androm3da](https://togithub.com/androm3da)` in [rust-lang/libc#3335 - feat: add close_range for glibc by [`@​SteveLauC](https://togithub.com/SteveLauC)` in [rust-lang/libc#3373 - Update crate version to 0.2.149 by [`@​nikarh](https://togithub.com/nikarh)` in [rust-lang/libc#3360 #### New Contributors - [`@​Sword-Destiny](https://togithub.com/Sword-Destiny)` made their first contribution in [rust-lang/libc#3333 - [`@​Brijeshkrishna](https://togithub.com/Brijeshkrishna)` made their first contribution in [rust-lang/libc#3354 - [`@​anacrolix](https://togithub.com/anacrolix)` made their first contribution in [rust-lang/libc#3337 - [`@​4lDO2](https://togithub.com/4lDO2)` made their first contribution in [rust-lang/libc#3347 - [`@​pheki](https://togithub.com/pheki)` made their first contribution in [rust-lang/libc#3284 - [`@​0323pin](https://togithub.com/0323pin)` made their first contribution in [rust-lang/libc#3368 - [`@​w1redch4d](https://togithub.com/w1redch4d)` made their first contribution in [rust-lang/libc#3332 - [`@​Vtewari2311](https://togithub.com/Vtewari2311)` made their first contribution in [rust-lang/libc#3325 - [`@​lcruz99](https://togithub.com/lcruz99)` made their first contribution in [rust-lang/libc#3370 **Full Changelog**: rust-lang/libc@0.2.148...0.2.149 </details> <details> <summary>serde-rs/serde (serde)</summary> ### [`v1.0.190`](https://togithub.com/serde-rs/serde/releases/tag/v1.0.190) [Compare Source](https://togithub.com/serde-rs/serde/compare/v1.0.189...v1.0.190) - Preserve NaN sign when deserializing f32 from f64 or vice versa ([#​2637](https://togithub.com/serde-rs/serde/issues/2637)) ### [`v1.0.189`](https://togithub.com/serde-rs/serde/releases/tag/v1.0.189) [Compare Source](https://togithub.com/serde-rs/serde/compare/v1.0.188...v1.0.189) - Fix "cannot infer type" error when internally tagged enum contains untagged variant ([#​2613](https://togithub.com/serde-rs/serde/issues/2613), thanks [`@​ahl](https://togithub.com/ahl))` </details> <details> <summary>serde-rs/json (serde_json)</summary> ### [`v1.0.108`](https://togithub.com/serde-rs/json/releases/tag/v1.0.108) [Compare Source](https://togithub.com/serde-rs/json/compare/v1.0.107...v1.0.108) - Documentation improvements ([#​1075](https://togithub.com/serde-rs/json/issues/1075), [#​1081](https://togithub.com/serde-rs/json/issues/1081), [#​1082](https://togithub.com/serde-rs/json/issues/1082), thanks [`@​dimo414](https://togithub.com/dimo414)` and [`@​fritzrehde](https://togithub.com/fritzrehde))` </details> <details> <summary>assert-rs/trycmd (snapbox)</summary> ### [`v0.4.14`](https://togithub.com/assert-rs/trycmd/compare/snapbox-v0.4.13...snapbox-v0.4.14) [Compare Source](https://togithub.com/assert-rs/trycmd/compare/snapbox-v0.4.13...snapbox-v0.4.14) </details> <details> <summary>dtolnay/syn (syn)</summary> ### [`v2.0.38`](https://togithub.com/dtolnay/syn/releases/tag/2.0.38) [Compare Source](https://togithub.com/dtolnay/syn/compare/2.0.37...2.0.38) - Fix *"method 'peek' has an incompatible type for trait"* error when defining `bool` as a custom keyword ([#​1518](https://togithub.com/dtolnay/syn/issues/1518), thanks [`@​Vanille-N](https://togithub.com/Vanille-N))` </details> <details> <summary>Stebalien/tempfile (tempfile)</summary> ### [`v3.8.1`](https://togithub.com/Stebalien/tempfile/blob/HEAD/CHANGELOG.md#381) - Update rustix to fix a potential panic on `persist_noclobber` on android. - Update redox_syscall to 0.4 (on redox). - Fix some docs typos. </details> <details> <summary>dtolnay/thiserror (thiserror)</summary> ### [`v1.0.50`](https://togithub.com/dtolnay/thiserror/releases/tag/1.0.50) [Compare Source](https://togithub.com/dtolnay/thiserror/compare/1.0.49...1.0.50) - Improve diagnostic when a #\[source], #\[from], or #\[transparant] attribute refers to a type that has no std::error::Error impl ([#​258](https://togithub.com/dtolnay/thiserror/issues/258), thanks [`@​de-vri-es](https://togithub.com/de-vri-es))` </details> <details> <summary>toml-rs/toml (toml)</summary> ### [`v0.8.6`](https://togithub.com/toml-rs/toml/compare/toml-v0.8.5...toml-v0.8.6) [Compare Source](https://togithub.com/toml-rs/toml/compare/toml-v0.8.5...toml-v0.8.6) ### [`v0.8.5`](https://togithub.com/toml-rs/toml/compare/toml-v0.8.4...toml-v0.8.5) [Compare Source](https://togithub.com/toml-rs/toml/compare/toml-v0.8.4...toml-v0.8.5) ### [`v0.8.4`](https://togithub.com/toml-rs/toml/compare/toml-v0.8.3...toml-v0.8.4) [Compare Source](https://togithub.com/toml-rs/toml/compare/toml-v0.8.3...toml-v0.8.4) ### [`v0.8.3`](https://togithub.com/toml-rs/toml/compare/toml-v0.8.2...toml-v0.8.3) [Compare Source](https://togithub.com/toml-rs/toml/compare/toml-v0.8.2...toml-v0.8.3) </details> <details> <summary>tokio-rs/tracing (tracing)</summary> ### [`v0.1.40`](https://togithub.com/tokio-rs/tracing/releases/tag/tracing-0.1.40): tracing 0.1.40 [Compare Source](https://togithub.com/tokio-rs/tracing/compare/tracing-0.1.39...tracing-0.1.40) This release fixes a potential stack use-after-free in the `Instrument::into_inner` method. Only uses of this method are affected by this bug. ##### Fixed - Use `mem::ManuallyDrop` instead of `mem::forget` in `Instrument::into_inner` ([#​2765]) [#​2765]: https://togithub.com/tokio-rs/tracing/pull/2765 Thanks to [`@​cramertj](https://togithub.com/cramertj)` and [`@​manishearth](https://togithub.com/manishearth)` for finding and fixing this issue! ### [`v0.1.39`](https://togithub.com/tokio-rs/tracing/releases/tag/tracing-0.1.39): tracing 0.1.39 [Compare Source](https://togithub.com/tokio-rs/tracing/compare/tracing-0.1.38...tracing-0.1.39) This release adds several additional features to the `tracing` macros. In addition, it updates the `tracing-core` dependency to [v0.1.32][core-0.1.32] and the `tracing-attributes` dependency to [v0.1.27][attrs-0.1.27]. ##### Added - Allow constant field names in macros ([#​2617]) - Allow setting event names in macros ([#​2699]) - **core**: Allow `ValueSet`s of any length ([#​2508]) ##### Changed - `tracing-attributes`: updated to [0.1.27][attrs-0.1.27] - `tracing-core`: updated to [0.1.32][core-0.1.32] - **attributes**: Bump minimum version of proc-macro2 to 1.0.60 ([#​2732]) - **attributes**: Generate less dead code for async block return type hint ([#​2709]) ##### Fixed - Use fully qualified names in macros for items exported from std prelude ([#​2621], [#​2757]) - **attributes**: Allow \[`clippy::let_with_type_underscore`] in macro-generated code (\[[#​2609](https://togithub.com/tokio-rs/tracing/issues/2609)]) - **attributes**: Allow `unknown_lints` in macro-generated code ([#​2626]) - **attributes**: Fix a compilation error in `#[instrument]` when the `"log"` feature is enabled ([#​2599]) ##### Documented - Add `axum-insights` to relevant crates. ([#​2713]) - Fix link to RAI pattern crate documentation (\[[#​2612](https://togithub.com/tokio-rs/tracing/issues/2612)]) - Fix docs typos and warnings ([#​2581]) - Add `clippy-tracing` to related crates ([#​2628]) - Add `tracing-cloudwatch` to related crates ([#​2667]) - Fix deadlink to `tracing-etw` repo ([#​2602]) [#​2617]: https://togithub.com/tokio-rs/tracing/pull/2617 [#​2699]: https://togithub.com/tokio-rs/tracing/pull/2699 [#​2508]: https://togithub.com/tokio-rs/tracing/pull/2508 [#​2621]: https://togithub.com/tokio-rs/tracing/pull/2621 [#​2713]: https://togithub.com/tokio-rs/tracing/pull/2713 [#​2581]: https://togithub.com/tokio-rs/tracing/pull/2581 [#​2628]: https://togithub.com/tokio-rs/tracing/pull/2628 [#​2667]: https://togithub.com/tokio-rs/tracing/pull/2667 [#​2602]: https://togithub.com/tokio-rs/tracing/pull/2602 [#​2626]: https://togithub.com/tokio-rs/tracing/pull/2626 [#​2757]: https://togithub.com/tokio-rs/tracing/pull/2757 [#​2732]: https://togithub.com/tokio-rs/tracing/pull/2732 [#​2709]: https://togithub.com/tokio-rs/tracing/pull/2709 [#​2599]: https://togithub.com/tokio-rs/tracing/pull/2599 [`let_with_type_underscore`]: http://rust-lang.github.io/rust-clippy/rust-1.70.0/index.html#let_with_type_underscore [attrs-0.1.27]: https://togithub.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.27 [core-0.1.32]: https://togithub.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.32 ### [`v0.1.38`](https://togithub.com/tokio-rs/tracing/releases/tag/tracing-0.1.38): tracing 0.1.38 [Compare Source](https://togithub.com/tokio-rs/tracing/compare/tracing-0.1.37...tracing-0.1.38) This `tracing` release changes the `Drop` implementation for `Instrumented` `Future`s so that the attached `Span` is entered when dropping the `Future`. This means that events emitted by the `Future`'s `Drop` implementation will now be recorded within its `Span`. It also adds `#[inline]` hints to methods called in the `event!` macro's expansion, for an improvement in both binary size and performance. Additionally, this release updates the `tracing-attributes` dependency to [v0.1.24][attrs-0.1.24], which updates the [`syn`][syn] dependency to v2.x.x. `tracing-attributes` v0.1.24 also includes improvements to the `#[instrument]` macro; see [the `tracing-attributes` 0.1.24 release notes][attrs-0.1.24] for details. ##### Added - `Instrumented` futures will now enter the attached `Span` in their `Drop` implementation, allowing events emitted when dropping the future to occur within the span ([#​2562](https://togithub.com/tokio-rs/tracing/issues/2562)) - `#[inline]` attributes for methods called by the `event!` macros, making generated code smaller ([#​2555](https://togithub.com/tokio-rs/tracing/issues/2555)) - **attributes**: `level` argument to `#[instrument(err)]` and `#[instrument(ret)]` to override the level of the generated return value event ([#​2335](https://togithub.com/tokio-rs/tracing/issues/2335)) - **attributes**: Improved compiler error message when `#[instrument]` is added to a `const fn` ([#​2418](https://togithub.com/tokio-rs/tracing/issues/2418)) ##### Changed - `tracing-attributes`: updated to [0.1.24][attrs-0.1.24] - Removed unneeded `cfg-if` dependency ([#​2553](https://togithub.com/tokio-rs/tracing/issues/2553)) - **attributes**: Updated [`syn`][syn] dependency to 2.0 ([#​2516](https://togithub.com/tokio-rs/tracing/issues/2516)) ##### Fixed - **attributes**: Fix `clippy::unreachable` warnings in `#[instrument]`-generated code ([#​2356](https://togithub.com/tokio-rs/tracing/issues/2356)) - **attributes**: Removed unused "visit" feature flag from `syn` dependency ([#​2530](https://togithub.com/tokio-rs/tracing/issues/2530)) ##### Documented - **attributes**: Documented default level for `#[instrument(err)]` ([#​2433](https://togithub.com/tokio-rs/tracing/issues/2433)) - **attributes**: Improved documentation for levels in `#[instrument]` ([#​2350](https://togithub.com/tokio-rs/tracing/issues/2350)) Thanks to [`@​nitnelave](https://togithub.com/nitnelave),` [`@​jsgf](https://togithub.com/jsgf),` [`@​Abhicodes-crypto](https://togithub.com/Abhicodes-crypto),` [`@​LukeMathWalker](https://togithub.com/LukeMathWalker),` [`@​andrewpollack](https://togithub.com/andrewpollack),` [`@​quad](https://togithub.com/quad),` [`@​klensy](https://togithub.com/klensy),` [`@​davidpdrsn](https://togithub.com/davidpdrsn),` [`@​dbidwell94](https://togithub.com/dbidwell94),` [`@​ldm0](https://togithub.com/ldm0),` [`@​NobodyXu](https://togithub.com/NobodyXu),` [`@​ilsv](https://togithub.com/ilsv),` and [`@​daxpedda](https://togithub.com/daxpedda)` for contributing to this release! [`syn`]: https://crates.io/crates/syn [attrs-0.1.24]: https://togithub.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.24 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 5am on the first day of the month" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/rust-lang/cargo). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzcuMzEuNSIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals:
bufread::GzDecoder,bufread::GzEncoder,bufread::MultiGzDecoder.Fix #374
I'm not a fluent english speaker and know little about flate2 internals, feel free to edit this PR.