summaryrefslogtreecommitdiffstats
path: root/vendor/drop_bomb
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 12:02:58 +0000
commit698f8c2f01ea549d77d7dc3338a12e04c11057b9 (patch)
tree173a775858bd501c378080a10dca74132f05bc50 /vendor/drop_bomb
parentInitial commit. (diff)
downloadrustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.tar.xz
rustc-698f8c2f01ea549d77d7dc3338a12e04c11057b9.zip
Adding upstream version 1.64.0+dfsg1.upstream/1.64.0+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/drop_bomb')
-rw-r--r--vendor/drop_bomb/.cargo-checksum.json1
-rw-r--r--vendor/drop_bomb/Cargo.toml21
-rw-r--r--vendor/drop_bomb/LICENSE-APACHE201
-rw-r--r--vendor/drop_bomb/LICENSE-MIT23
-rw-r--r--vendor/drop_bomb/README.md10
-rw-r--r--vendor/drop_bomb/src/lib.rs206
6 files changed, 462 insertions, 0 deletions
diff --git a/vendor/drop_bomb/.cargo-checksum.json b/vendor/drop_bomb/.cargo-checksum.json
new file mode 100644
index 000000000..16de68d45
--- /dev/null
+++ b/vendor/drop_bomb/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"1273bc1c6d16e67006d49dc83aefb64f87d201b4f01024b389151d2dcf256e44","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"23f18e03dc49df91622fe2a76176497404e46ced8a715d9d2b67a7446571cca3","README.md":"8d8b039767810563e5fa50f9bc75c4ebe57f2dd82f352aef8f39dbbd175feec1","src/lib.rs":"b00a8c61ad65da51e5e179479597b2c78d4e0b616526955d58f2a62e428c322c"},"package":"9bda8e21c04aca2ae33ffc2fd8c23134f3cac46db123ba97bd9d3f3b8a4a85e1"} \ No newline at end of file
diff --git a/vendor/drop_bomb/Cargo.toml b/vendor/drop_bomb/Cargo.toml
new file mode 100644
index 000000000..f878a7bf9
--- /dev/null
+++ b/vendor/drop_bomb/Cargo.toml
@@ -0,0 +1,21 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+name = "drop_bomb"
+version = "0.1.5"
+authors = ["Aleksey Kladov <aleksey.kladov@gmail.com>"]
+exclude = ["*.jpg"]
+description = "A runtime guard for implementing linear types.\n"
+categories = ["rust-patterns"]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/matklad/drop_bomb"
diff --git a/vendor/drop_bomb/LICENSE-APACHE b/vendor/drop_bomb/LICENSE-APACHE
new file mode 100644
index 000000000..16fe87b06
--- /dev/null
+++ b/vendor/drop_bomb/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/vendor/drop_bomb/LICENSE-MIT b/vendor/drop_bomb/LICENSE-MIT
new file mode 100644
index 000000000..31aa79387
--- /dev/null
+++ b/vendor/drop_bomb/LICENSE-MIT
@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/vendor/drop_bomb/README.md b/vendor/drop_bomb/README.md
new file mode 100644
index 000000000..1a8bf53d9
--- /dev/null
+++ b/vendor/drop_bomb/README.md
@@ -0,0 +1,10 @@
+# drop_bomb
+
+[![Build Status](https://travis-ci.org/matklad/drop_bomb.svg?branch=master)](https://travis-ci.org/matklad/drop_bomb)
+[![Crates.io](https://img.shields.io/crates/v/drop_bomb.svg)](https://crates.io/crates/drop_bomb)
+[![API reference](https://docs.rs/drop_bomb/badge.svg)](https://docs.rs/drop_bomb/)
+
+<img align="left" src="./Merkwürdigliebe.jpg">
+
+ A runtime guard for (~~protecting your precious bodily fluids~~) implementing linear types.
+ See the [docs](https://docs.rs/drop_bomb/) for more.
diff --git a/vendor/drop_bomb/src/lib.rs b/vendor/drop_bomb/src/lib.rs
new file mode 100644
index 000000000..a712e7c8c
--- /dev/null
+++ b/vendor/drop_bomb/src/lib.rs
@@ -0,0 +1,206 @@
+//! # drop_bomb
+//!
+//! `drop_bomb` provides two types, `DropBomb` and `DebugDropBomb`,
+//! which panic in `drop` with a specified message unless
+//! defused. This is useful as a building-block for runtime-checked
+//! linear types.
+//!
+//! For example, one can build a variant of `BufWriter` which enforces
+//! handling of errors during flush.
+//!
+//! ```rust
+//! extern crate drop_bomb;
+//!
+//! use std::io::{Write, BufWriter, Result};
+//! use drop_bomb::DropBomb;
+//!
+//! struct CheckedBufWriter<W: Write> {
+//! inner: BufWriter<W>,
+//! bomb: DropBomb,
+//! }
+//!
+//! impl<W: Write> CheckedBufWriter<W> {
+//! fn new(inner: BufWriter<W>) -> CheckedBufWriter<W> {
+//! let bomb = DropBomb::new(
+//! "CheckedBufWriter must be explicitly closed \
+//! to handle potential errors on flush"
+//! );
+//! CheckedBufWriter { inner, bomb }
+//! }
+//!
+//! fn close(mut self) -> Result<()> {
+//! self.bomb.defuse();
+//! self.inner.flush()?;
+//! Ok(())
+//! }
+//! }
+//! ```
+//!
+//! ## Notes:
+//!
+//! * Bombs do nothing if a thread is already panicking.
+//! * When `#[cfg(debug_assertions)]` is disabled, `DebugDropBomb` is
+//! always defused and has a zero size.
+use std::borrow::Cow;
+
+#[derive(Debug)]
+#[must_use]
+pub struct DropBomb(RealBomb);
+
+impl DropBomb {
+ pub fn new(msg: impl Into<Cow<'static, str>>) -> DropBomb {
+ DropBomb(RealBomb::new(msg.into()))
+ }
+ pub fn defuse(&mut self) {
+ self.set_defused(true)
+ }
+ pub fn set_defused(&mut self, defused: bool) {
+ self.0.set_defused(defused)
+ }
+ pub fn is_defused(&self) -> bool {
+ self.0.is_defused()
+ }
+}
+
+#[derive(Debug)]
+#[must_use]
+pub struct DebugDropBomb(DebugBomb);
+
+impl DebugDropBomb {
+ pub fn new(msg: impl Into<Cow<'static, str>>) -> DebugDropBomb {
+ DebugDropBomb(DebugBomb::new(msg.into()))
+ }
+ pub fn defuse(&mut self) {
+ self.set_defused(true)
+ }
+ pub fn set_defused(&mut self, defused: bool) {
+ self.0.set_defused(defused)
+ }
+ pub fn is_defused(&self) -> bool {
+ self.0.is_defused()
+ }
+}
+
+#[cfg(debug_assertions)]
+type DebugBomb = RealBomb;
+#[cfg(not(debug_assertions))]
+type DebugBomb = FakeBomb;
+
+#[derive(Debug)]
+struct RealBomb {
+ msg: Cow<'static, str>,
+ defused: bool,
+}
+
+impl RealBomb {
+ fn new(msg: Cow<'static, str>) -> RealBomb {
+ RealBomb {
+ msg: msg.into(),
+ defused: false,
+ }
+ }
+ fn set_defused(&mut self, defused: bool) {
+ self.defused = defused
+ }
+ fn is_defused(&self) -> bool {
+ self.defused
+ }
+}
+
+impl Drop for RealBomb {
+ fn drop(&mut self) {
+ if !self.defused && !::std::thread::panicking() {
+ panic!("{}", self.msg)
+ }
+ }
+}
+
+#[derive(Debug)]
+#[cfg(not(debug_assertions))]
+struct FakeBomb {}
+
+#[cfg(not(debug_assertions))]
+impl FakeBomb {
+ fn new(_msg: Cow<'static, str>) -> FakeBomb {
+ FakeBomb {}
+ }
+ fn set_defused(&mut self, _defused: bool) {}
+ fn is_defused(&self) -> bool {
+ true
+ }
+}
+
+#[cfg(not(debug_assertions))]
+impl Drop for FakeBomb {
+ fn drop(&mut self) {}
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ #[should_panic(expected = "Kaboom")]
+ fn armed_bomb_bombs() {
+ let _b = DropBomb::new("Kaboom");
+ }
+
+ #[test]
+ fn defused_bomb_is_safe() {
+ let mut b = DropBomb::new("Kaboom");
+ assert!(!b.is_defused());
+ b.defuse();
+ assert!(b.is_defused());
+ }
+
+ #[test]
+ #[should_panic(expected = r#"printf("sucks to be you"); exit(666);"#)]
+ fn no_double_panics() {
+ let _b = DropBomb::new("Kaboom");
+ panic!(r#"printf("sucks to be you"); exit(666);"#)
+ }
+
+ #[test]
+ #[should_panic(expected = "Kaboom")]
+ #[cfg(debug_assertions)]
+ fn debug_bomb_bombs_if_debug() {
+ let _b = DebugDropBomb::new("Kaboom");
+ }
+
+ #[test]
+ #[cfg(not(debug_assertions))]
+ fn debug_bomb_bombs_if_debug() {
+ let _b = DebugDropBomb::new("Kaboom");
+ }
+
+ #[test]
+ fn defused_bomb_is_safe_if_debug() {
+ let mut b = DebugDropBomb::new("Kaboom");
+ #[cfg(debug_assertions)]
+ assert!(!b.is_defused());
+ #[cfg(not(debug_assertions))]
+ assert!(b.is_defused());
+ b.defuse();
+ assert!(b.is_defused());
+ }
+
+ #[test]
+ #[should_panic(expected = r#"printf("sucks to be you"); exit(666);"#)]
+ fn no_double_panics_if_debug() {
+ let _b = DebugDropBomb::new("Kaboom");
+ panic!(r#"printf("sucks to be you"); exit(666);"#)
+ }
+
+ #[test]
+ #[cfg(not(debug_assertions))]
+ fn debug_bomb_is_zst() {
+ assert_eq!(::std::mem::size_of::<DebugDropBomb>(), 0);
+ }
+
+ #[test]
+ fn check_traits() {
+ fn assert_traits<T: ::std::fmt::Debug + Send + Sync>() {}
+ assert_traits::<DropBomb>();
+ assert_traits::<DebugDropBomb>();
+ }
+}