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.

Sign up for GitHub

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

Jump to bottom

Add panics section to docs #80

Closed
wants to merge 1 commit into from
Closed

Add panics section to docs #80

wants to merge 1 commit into from

Conversation

richard-uk1
Copy link

No description provided.

torkleyy
torkleyy approved these changes Apr 2, 2018
View reviewed changes
Copy link
Member

@torkleyy torkleyy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I skipped it and referred to fetch out of laziness, but I guess it's important enough to duplicate.

src/res/mod.rs
/// # Panics
///
/// Panics if the resource doesn't exist.
/// Panics if the resource is being accessed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe "is already being accessed"

@richard-uk1
Copy link
Author

I've made the suggested change, but I'm going to roll this up with some other documentation suggestions.

@richard-uk1 richard-uk1 closed this Apr 2, 2018
@richard-uk1 richard-uk1 deleted the patch-1 branch April 2, 2018 13:38
bors bot added a commit that referenced this pull request Jun 1, 2019
@bors @dependabot-preview
Merge #142
cf82d3d 
142: Update hashbrown requirement from 0.3.0 to 0.4.0 r=torkleyy a=dependabot-preview[bot]

Updates the requirements on [hashbrown](https://github.com/rust-lang/hashbrown) to permit the latest version.
<details>
<summary>Changelog</summary>

*Sourced from [hashbrown's changelog](https://github.com/rust-lang/hashbrown/blob/master/CHANGELOG.md).*

> ## [v0.4.0] - 2019-05-30
> 
> ### Fixed
> - Fixed `Send` trait bounds on `IterMut` not matching the libstd one. ([#82](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/82))
> 
> ## [v0.3.1] - 2019-05-30
> 
> ### Fixed
> - Fixed incorrect use of slice in unsafe code. ([#80](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/80))
> 
> ## [v0.3.0] - 2019-04-23
> 
> ### Changed
> - Changed shrink_to to not panic if min_capacity < capacity. ([#67](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/67))
> 
> ### Fixed
> - Worked around emscripten bug emscripten-core/emscripten-fastcomp#258. ([#66](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/66))
> 
> ## [v0.2.2] - 2019-04-16
> 
> ### Fixed
> - Inlined non-nightly lowest_set_bit_nonzero. ([#64](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/64))
> - Fixed build on latest nightly. ([#65](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/65))
> 
> ## [v0.2.1] - 2019-04-14
> 
> ### Changed
> - Use for_each in map Extend and FromIterator. ([#58](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/58))
> - Improved worst-case performance of HashSet.is_subset. ([#61](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/61))
> 
> ### Fixed
> - Removed incorrect debug_assert. ([#60](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/60))
> 
> ## [v0.2.0] - 2019-03-31
> 
> ### Changed
> - The code has been updated to Rust 2018 edition. This means that the minimum
>   Rust version has been bumped to 1.31 (2018 edition).
> 
> ### Added
> - Added `insert_with_hasher` to the raw_entry API to allow `K: !(Hash + Eq)`. ([#54](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/54))
> - Added support for using hashbrown as the hash table implementation in libstd. ([#46](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/46))
> 
> ### Fixed
> - Fixed cargo build with minimal-versions. ([#45](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/45))
> - Fixed `#[may_dangle]` attributes to match the libstd `HashMap`. ([#46](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/46))
> - ZST keys and values are now handled properly. ([#46](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/46))
> 
> ## [v0.1.8] - 2019-01-14
> 
></tr></table> ... (truncated)
</details>
<details>
<summary>Commits</summary>

- [`987b962`](rust-lang/hashbrown@987b962) Version 0.4.0
- [`a9ddbcf`](rust-lang/hashbrown@a9ddbcf) Auto merge of [#82](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/82) - Amanieu:itermut_send, r=Amanieu
- [`a4eba4f`](rust-lang/hashbrown@a4eba4f) Fix the bounds on K for the Send impl of IterMut
- [`1889600`](rust-lang/hashbrown@1889600) Version 0.3.1
- [`c765ea0`](rust-lang/hashbrown@c765ea0) Auto merge of [#80](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/80) - RalfJung:raw, r=Amanieu
- [`2693d12`](rust-lang/hashbrown@2693d12) cast the entire slice to a raw pointer, not just the first element
- [`4368aa4`](rust-lang/hashbrown@4368aa4) Auto merge of [#78](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/78) - RalfJung:miri, r=Amanieu
- [`419f2ac`](rust-lang/hashbrown@419f2ac) skip Miri tests if the setup fails
- [`538d149`](rust-lang/hashbrown@538d149) Merge pull request [#77](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/77) from lzutao/refresh-doc
- [`70afa1b`](rust-lang/hashbrown@70afa1b) Use docs.rs badge
- Additional commits viewable in [compare view](rust-lang/hashbrown@v0.3.0...v0.4.0)
</details>
<br />

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot ignore this [patch|minor|major] version` will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

</details>

[//]: # (dependabot-acquisition-announcement-start)

---

<a href='https://dependabot.com/blog/hello-github/'><img width='376' alt='Dependabot has been acquired by GitHub  🎉' src='https://user-images.githubusercontent.com/20165/58035530-e739b700-7b20-11e9-9d1b-12a7630b84e0.png'></a>

[//]: # (dependabot-acquisition-announcement-end)

Co-authored-by: dependabot-preview[bot] <dependabot-preview[bot]@users.noreply.github.com>
bors bot added a commit that referenced this pull request Jun 13, 2019
@bors @dependabot-preview
Merge #143
b5a3da4 
143: Update hashbrown requirement from 0.4.0 to 0.5.0 r=torkleyy a=dependabot-preview[bot]

Updates the requirements on [hashbrown](https://github.com/rust-lang/hashbrown) to permit the latest version.
<details>
<summary>Changelog</summary>

*Sourced from [hashbrown's changelog](https://github.com/rust-lang/hashbrown/blob/master/CHANGELOG.md).*

> ## [v0.5.0] - 2019-06-12
> 
> ### Fixed
> - Resize with a more conservative amount of space after deletions. ([#86](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/86))
> 
> ### Changed
> - Exposed the Layout of the failed allocation in CollectionAllocErr::AllocErr. ([#89](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/89))
> 
> ## [v0.4.0] - 2019-05-30
> 
> ### Fixed
> - Fixed `Send` trait bounds on `IterMut` not matching the libstd one. ([#82](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/82))
> 
> ## [v0.3.1] - 2019-05-30
> 
> ### Fixed
> - Fixed incorrect use of slice in unsafe code. ([#80](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/80))
> 
> ## [v0.3.0] - 2019-04-23
> 
> ### Changed
> - Changed shrink_to to not panic if min_capacity < capacity. ([#67](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/67))
> 
> ### Fixed
> - Worked around emscripten bug emscripten-core/emscripten-fastcomp#258. ([#66](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/66))
> 
> ## [v0.2.2] - 2019-04-16
> 
> ### Fixed
> - Inlined non-nightly lowest_set_bit_nonzero. ([#64](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/64))
> - Fixed build on latest nightly. ([#65](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/65))
> 
> ## [v0.2.1] - 2019-04-14
> 
> ### Changed
> - Use for_each in map Extend and FromIterator. ([#58](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/58))
> - Improved worst-case performance of HashSet.is_subset. ([#61](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/61))
> 
> ### Fixed
> - Removed incorrect debug_assert. ([#60](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/60))
> 
> ## [v0.2.0] - 2019-03-31
> 
> ### Changed
> - The code has been updated to Rust 2018 edition. This means that the minimum
>   Rust version has been bumped to 1.31 (2018 edition).
> 
> ### Added
> - Added `insert_with_hasher` to the raw_entry API to allow `K: !(Hash + Eq)`. ([#54](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/54))
> - Added support for using hashbrown as the hash table implementation in libstd. ([#46](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/46))
></tr></table> ... (truncated)
</details>
<details>
<summary>Commits</summary>

- [`e7cd4a5`](rust-lang/hashbrown@e7cd4a5) Version 0.5.0
- [`2c16341`](rust-lang/hashbrown@2c16341) Auto merge of [#89](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/89) - SimonSapin:layout, r=Amanieu
- [`c2e26e7`](rust-lang/hashbrown@c2e26e7) Expose the Layout of the failed allocation in CollectionAllocErr::AllocErr
- [`14bb115`](rust-lang/hashbrown@14bb115) Auto merge of [#87](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/87) - josephrocca:patch-1, r=Amanieu
- [`80dc544`](rust-lang/hashbrown@80dc544) Add simple usage code
- [`b240ee0`](rust-lang/hashbrown@b240ee0) Auto merge of [#86](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/86) - edre:rehash, r=Amanieu
- [`afc20d7`](rust-lang/hashbrown@afc20d7) Resize with a more conservative amount of space when inserting after deletions.
- [`119f429`](rust-lang/hashbrown@119f429) Auto merge of [#84](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/84) - edre:bench, r=Amanieu
- [`8783490`](rust-lang/hashbrown@8783490) Update insert_erase benchmark to keep the table size constant.
- [`143609d`](rust-lang/hashbrown@143609d) Auto merge of [#83](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/83) - edre:bench, r=Amanieu
- Additional commits viewable in [compare view](rust-lang/hashbrown@v0.4.0...v0.5.0)
</details>
<br />

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot ignore this [patch|minor|major] version` will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

</details>

Co-authored-by: dependabot-preview[bot] <dependabot-preview[bot]@users.noreply.github.com>
bors bot added a commit that referenced this pull request Aug 26, 2019
@bors @dependabot-preview
Merge #153
15f75a2 
153: Update hashbrown requirement from 0.5.0 to 0.6.0 r=torkleyy a=dependabot-preview[bot]

Updates the requirements on [hashbrown](https://github.com/rust-lang/hashbrown) to permit the latest version.
<details>
<summary>Changelog</summary>

*Sourced from [hashbrown's changelog](https://github.com/rust-lang/hashbrown/blob/master/CHANGELOG.md).*

> ## [v0.6.0] - 2019-08-13
> 
> ### Fixed
> - Fixed AHash accidentally depending on `std`. ([#110](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/110))
> 
> ### Changed
> - The minimum Rust version has been bumped to 1.32 (due to `rand` dependency).
> 
> ## ~~[v0.5.1] - 2019-08-04~~
> 
> This release was _yanked_ due to a breaking change for users of `no-default-features`.
> 
> ### Added
> - The experimental and unsafe `RawTable` API is available under the "raw" feature. ([#108](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/108))
> - Added entry-like methods for `HashSet`. ([#98](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/98))
> 
> ### Changed
> - Changed the default hasher from FxHash to AHash. ([#97](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/97))
> - `hashbrown` is now fully `no_std` on recent Rust versions (1.36+). ([#96](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/96))
> 
> ### Fixed
> - We now avoid growing the table during insertions when it wasn't necessary. ([#106](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/106))
> - `RawOccupiedEntryMut` now properly implements `Send` and `Sync`. ([#100](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/100))
> - Relaxed `lazy_static` version. ([#92](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/92))
> 
> ## [v0.5.0] - 2019-06-12
> 
> ### Fixed
> - Resize with a more conservative amount of space after deletions. ([#86](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/86))
> 
> ### Changed
> - Exposed the Layout of the failed allocation in CollectionAllocErr::AllocErr. ([#89](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/89))
> 
> ## [v0.4.0] - 2019-05-30
> 
> ### Fixed
> - Fixed `Send` trait bounds on `IterMut` not matching the libstd one. ([#82](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/82))
> 
> ## [v0.3.1] - 2019-05-30
> 
> ### Fixed
> - Fixed incorrect use of slice in unsafe code. ([#80](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/80))
> 
> ## [v0.3.0] - 2019-04-23
> 
> ### Changed
> - Changed shrink_to to not panic if min_capacity < capacity. ([#67](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/67))
> 
> ### Fixed
> - Worked around emscripten bug emscripten-core/emscripten-fastcomp#258. ([#66](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/66))
></tr></table> ... (truncated)
</details>
<details>
<summary>Commits</summary>

- [`0a62c3e`](rust-lang/hashbrown@0a62c3e) Version 0.6.0
- [`0c1209a`](rust-lang/hashbrown@0c1209a) Auto merge of [#110](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/110) - Amanieu:no_std_ci, r=Amanieu
- [`8ae33c9`](rust-lang/hashbrown@8ae33c9) Don't use cross for thumb target CI
- [`3239c2b`](rust-lang/hashbrown@3239c2b) Fix clippy warnings
- [`12c55b6`](rust-lang/hashbrown@12c55b6) Bump minimum Rust version to 1.32
- [`fb0a938`](rust-lang/hashbrown@fb0a938) Bump minimum ahash version to 0.2.11
- [`bacb169`](rust-lang/hashbrown@bacb169) Merge pull request [#111](https://github-redirect.dependabot.com/rust-lang/hashbrown/issues/111) from RalfJung/readme
- [`2921920`](rust-lang/hashbrown@2921920) when hashers with different design goals are compared, that should be noted
- [`aecb361`](rust-lang/hashbrown@aecb361) Check in CI that the crate builds on targets without libstd
- [`167eb54`](rust-lang/hashbrown@167eb54) Version 0.5.1
- Additional commits viewable in [compare view](rust-lang/hashbrown@v0.5.0...v0.6.0)
</details>
<br />

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language
- `@dependabot badge me` will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot [dashboard](https://app.dependabot.com):
- Update frequency (including time of day and day of week)
- Automerge options (never/patch/minor, and dev/runtime dependencies)
- Pull request limits (per update run and/or open at any time)
- Out-of-range updates (receive only lockfile updates, if desired)
- Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

</details>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@torkleyy torkleyy torkleyy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@richard-uk1 @torkleyy