Adding upstream version 0.1.1.upstream/0.1.1upstream

Signed-off-by: Daniel Baumann <daniel@debian.org>

8 files changed, 570 insertions, 0 deletions

diff --git a/.cargo_vcs_info.json b/.cargo_vcs_info.json
new file mode 100644
index 0000000..ceb8b28
--- /dev/null
+++ b/.cargo_vcs_info.json
@@ -0,0 +1,5 @@
+{
+  "git": {
+    "sha1": "1377f761c268a89e16fdf5039d8678b1dc167875"
+  }
+}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e85ef84
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+/target

+Cargo.lock

diff --git a/Cargo.toml b/Cargo.toml
new file mode 100644
index 0000000..bfe33c6
--- /dev/null
+++ b/Cargo.toml
@@ -0,0 +1,22 @@
+# 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 are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "soft_assert"
+version = "0.1.1"
+description = "Non-panicking assertions"
+keywords = ["macros", "utility"]
+categories = ["rust-patterns"]
+license = "Apache-2.0/MIT"
+repository = "https://github.com/Cyborus04/soft_assert"
+
+[dependencies]
diff --git a/Cargo.toml.orig b/Cargo.toml.orig
new file mode 100644
index 0000000..b1f1d30
--- /dev/null
+++ b/Cargo.toml.orig
@@ -0,0 +1,13 @@
+[package]

+categories = ["rust-patterns"]

+description = "Non-panicking assertions"

+edition = "2018"

+keywords = ["macros", "utility"]

+license = "Apache-2.0/MIT"

+name = "soft_assert"

+repository = "https://github.com/Cyborus04/soft_assert"

+version = "0.1.1"

+

+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

+

+[dependencies]

diff --git a/LICENSE-APACHE b/LICENSE-APACHE
new file mode 100644
index 0000000..21254fc
--- /dev/null
+++ b/LICENSE-APACHE
@@ -0,0 +1,176 @@
+                                 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
\ No newline at end of file
diff --git a/LICENSE-MIT b/LICENSE-MIT
new file mode 100644
index 0000000..2b1af07
--- /dev/null
+++ b/LICENSE-MIT
@@ -0,0 +1,17 @@
+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.
\ No newline at end of file
diff --git a/README.MD b/README.MD
new file mode 100644
index 0000000..02806c4
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,25 @@
+# `soft_assert`

+

+Various macros that return early if a given condition is false.

+Similar to the various `assert` macros in `std`

+

+## Usage

+

+Add the following to your `Cargo.toml`:

+

+```toml

+[dependencies]

+soft_assert = "0.1"

+```

+

+## License

+

+This project is licensed under either of

+

+* [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

+  ([LICENSE-APACHE](LICENSE-APACHE))

+

+* [MIT License](http://opensource.org/licenses/MIT)

+  ([LICENSE-MIT](LICENSE-MIT))

+

+at your option.

diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..024ba0e
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,310 @@
+#![deny(missing_docs)]

+#![no_std]

+

+//! A set of macros similar to the standard library's `assert_*` macros, but return early instead of panicking.

+//! # Example

+//! ```

+//! use soft_assert::*;

+//!

+//! fn not_twenty(x: i32) -> Option<i32> {

+//!     // This will return `Option::default()`, which is `None`

+//!     soft_assert_ne!(x, 20);

+//!     Some(x)

+//! }

+//!

+//! fn double_if_greater_than_5(x: i32) -> i32 {

+//!     // But here we don't want to return `i32::default()`,

+//!     // so we specify a return value.

+//!     soft_assert!(x > 5, x);

+//!     x * 2

+//! }

+//!

+//! fn main() {

+//!     assert!(not_twenty(10).is_some());   

+//!     assert!(not_twenty(20).is_none());   

+//!

+//!     let doubled = double_if_greater_than_5(13);

+//!     assert_eq!(doubled, 26);    

+//!     let not_doubled = double_if_greater_than_5(2);

+//!     assert_eq!(not_doubled, 2);   

+//! }

+//!

+//! ```

+//!

+//! This crate is `#![no_std]`

+

+#[macro_export]

+/// Asserts a condition is true, returning otherwise.

+///

+/// Non-panicking version of [`assert`](https://doc.rust-lang.org/std/macro.assert.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_assert!(false, Err(e))`. Ownership of any captured values is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+macro_rules! soft_assert {

+    ($e:expr) => {

+        if !$e {

+            return Default::default();

+        }

+    };

+    ($e:expr,) => {

+        $crate::soft_assert!($e)

+    };

+    ($e:expr, $failed:expr) => {

+        if !$e {

+            return $failed;

+        }

+    };

+    ($e:expr, $failed:expr,) => {

+        $crate::soft_assert!($e)

+    };

+}

+

+/// Asserts two values are equal, returning otherwise.

+///

+/// Non-panicking version of [`assert_eq`](https://doc.rust-lang.org/std/macro.assert_eq.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_assert_eq!(1, 2, Err(e))`. Ownership of any captured values is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+#[macro_export]

+macro_rules! soft_assert_eq {

+    ($x:expr, $y:expr) => {

+        if { $x } != { $y } {

+            return Default::default();

+        }

+    };

+    ($x:expr, $y:expr,) => {

+        $crate::soft_assert_eq!($x, $y)

+    };

+    ($x:expr, $y:expr, $failed:expr) => {

+        if { $x } != { $y } {

+            return $failed;

+        }

+    };

+    ($x:expr, $y:expr, $failed:expr,) => {

+        $crate::soft_assert_eq!($x, $y, $failed)

+    };

+}

+

+/// Asserts two values are not equal, returning otherwise.

+///

+/// Non-panicking version of [`assert_ne`](https://doc.rust-lang.org/std/macro.assert_ne.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_assert_ne!(2 + 2, 4, Err(e))`. Ownership of any captured values is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+#[macro_export]

+macro_rules! soft_assert_ne {

+    ($x:expr, $y:expr) => {

+        if { $x } == { $y } {

+            return Default::default();

+        }

+    };

+    ($x:expr, $y:expr,) => {

+        $crate::soft_assert_ne!($x, $y)

+    };

+    ($x:expr, $y:expr, $failed:expr) => {

+        if { $x } == { $y } {

+            return $failed;

+        }

+    };

+    ($x:expr, $y:expr, $failed:expr,) => {

+        $crate::soft_assert_ne!($x, $y, $failed)

+    };

+}

+

+#[macro_export]

+/// Asserts a value matches a pattern, returning otherwise.

+///

+/// Non-panicking version of [`assert_matches`](https://doc.rust-lang.org/std/assert_matches/macro.assert_matches.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_assert_matches!(x, None, Err(e))`. Ownership of any captured values is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+macro_rules! soft_assert_matches {

+    ($e:expr, $p:pat) => {

+        match $e {

+            $p => (),

+            _ => return Default::default();

+        }

+    };

+    ($e:expr, $p:pat,) => {

+        $crate::soft_assert_matches!($x, $y)

+    };

+    ($e:expr, $p:pat, $failed:expr) => {

+        match $e {

+            $p => (),

+            _ => return $failed;

+        }

+    };

+    ($e:expr, $p:pat, $failed:expr,) => {

+        $crate::soft_assert_matches!($x, $y, $failed)

+    };

+}

+

+/// If debug assertions are enabled, asserts a condition is true, returning otherwise.

+///

+/// Non-panicking version of [`debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_debug_assert!(false, Err(e))`. Ownership of the value is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+#[macro_export]

+macro_rules! soft_debug_assert {

+    ($e:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert!($e);

+    };

+    ($e:expr,) => {

+        $crate::soft_debug_assert!($e);

+    };

+    ($e:expr, $failed:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert!($e, $failed);

+    };

+    ($e:expr, $failed:expr,) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert!($e, $failed);

+    };

+}

+

+/// If debug assertions are enabled, asserts two values are equal, returning otherwise.

+///

+/// Non-panicking version of [`debug_assert_eq`](https://doc.rust-lang.org/std/macro.debug_assert_eq.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_debug_assert_eq!(1, 2, Err(e))`. Ownership of the value is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+#[macro_export]

+macro_rules! soft_debug_assert_eq {

+    ($x:expr, $y:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert_eq!($x, $y);

+    };

+    ($x:expr, $y:expr,) => {

+        $crate::soft_debug_assert_eq!($x, $y);

+    };

+    ($x:expr, $y:expr, $failed:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert_eq!($x, $y, $failed);

+    };

+    ($x:expr, $y:expr, $failed:expr,) => {

+        $crate::soft_debug_assert_eq!($x, $y, $failed);

+    };

+}

+

+/// If debug assertions are enabled, asserts two values are not equal, returning otherwise.

+///

+/// Non-panicking version of [`debug_assert_ne`](https://doc.rust-lang.org/std/macro.debug_assert.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_debug_assert_ne!(2 + 2, 4, Err(e))`. Ownership of the value is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+#[macro_export]

+macro_rules! soft_debug_assert_ne {

+    ($x:expr, $y:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert_ne!($x, $y);

+    };

+    ($x:expr, $y:expr,) => {

+        $crate::soft_debug_assert_ne!($x, $y);

+    };

+    ($x:expr, $y:expr, $failed:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert_ne!($x, $y, $failed);

+    };

+    ($x:expr, $y:expr, $failed:expr,) => {

+        $crate::soft_debug_assert_ne!($x, $y, $failed);

+    };

+}

+

+#[macro_export]

+/// Asserts a value matches a pattern, returning otherwise.

+///

+/// Non-panicking version of [`debug_assert_matches`](https://doc.rust-lang.org/std/assert_matches/macro.debug_assert_matches.html).

+///

+/// # Custom return values

+/// Unless otherwise specified, this will return the default value of the return type (if it has one).

+/// A custom value can be returned instead by supplying it as an additional argument (similar to `assert`'s custom message),

+/// i.e. `soft_debug_assert_match!(x, None, Err(e))`. Ownership of any captured values is only taken if the assertion fails, so you can

+/// continue to use them later on.

+///

+/// This does *not* perform `Err(..)`-wrapping, to allow returning any value.

+macro_rules! soft_debug_assert_matches {

+    ($e:expr, $p:pat) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert_match!($e, $p);

+    };

+    ($e:expr, $p:pat,) => {

+        $crate::soft_debug_assert_match!($e, $p);

+    };

+    ($e:expr, $p:pat, $failed:expr) => {

+        #[cfg(debug_assertions)]

+        $crate::soft_assert_match!($e, $p, $failed);

+    };

+    ($e:expr, $p:pat, $failed:expr,) => {

+        $crate::soft_debug_assert_match!($e, $p, $failed);

+    };

+}

+

+#[cfg(test)]

+mod tests {

+    use super::*;

+

+    #[test]

+    fn test() {

+        assert!((|| {

+            soft_assert!(true, false);

+            true

+        })());

+        assert!((|| {

+            soft_assert!(false, true);

+            false

+        })());

+        assert!((|| {

+            soft_assert_eq!((1..=10).sum::<i32>(), 55, false);

+            true

+        })());

+        assert!((|| {

+            soft_assert_eq!((1..=10).sum::<i32>(), 3141, true);

+            false

+        })());

+        assert!((|| {

+            soft_assert_ne!((1..=10).sum::<i32>(), 3151, false);

+            true

+        })());

+        assert!((|| {

+            soft_assert_ne!((1..=10).sum::<i32>(), 55, true);

+            false

+        })());

+    }

+}