aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorProfpatsch <mail@profpatsch.de>2018-07-26 20:45:55 +0200
committerProfpatsch <mail@profpatsch.de>2018-09-06 18:14:27 +0200
commit0e2aa97f3aa1341693885511fd78394b828c6477 (patch)
tree0e9e069dc0833babd35a917ce081269c54cd2c17
parentfc2c606a7ac8fb48be4181f777d029bd75c0c58a (diff)
lib/trivial: add assertMsg
-rw-r--r--lib/default.nix3
-rw-r--r--lib/trivial.nix20
2 files changed, 22 insertions, 1 deletions
diff --git a/lib/default.nix b/lib/default.nix
index dd6fcec75e2..fd3be3c6f4b 100644
--- a/lib/default.nix
+++ b/lib/default.nix
@@ -59,7 +59,8 @@ let
inherit (trivial) id const concat or and bitAnd bitOr bitXor bitNot
boolToString mergeAttrs flip mapNullable inNixShell min max
importJSON warn info nixpkgsVersion version mod compare
- splitByAndCompare functionArgs setFunctionArgs isFunction;
+ splitByAndCompare functionArgs setFunctionArgs isFunction
+ assertMsg;
inherit (fixedPoints) fix fix' extends composeExtensions
makeExtensible makeExtensibleWithCustomName;
diff --git a/lib/trivial.nix b/lib/trivial.nix
index e702b8cdcc9..bba284548d9 100644
--- a/lib/trivial.nix
+++ b/lib/trivial.nix
@@ -188,6 +188,26 @@ rec {
warn = msg: builtins.trace "WARNING: ${msg}";
info = msg: builtins.trace "INFO: ${msg}";
+ /* Print a trace message if pred is false.
+ Intended to be used to augment asserts with helpful error messages.
+
+ Example:
+ assertMsg false "nope"
+ => false
+ stderr> trace: nope
+
+ assert (assertMsg ("foo" == "bar") "foo is not bar, silly"); ""
+ stderr> trace: foo is not bar, silly
+ stderr> assert failed at …
+
+ Type:
+ assertMsg :: Bool -> String -> Bool
+ */
+ assertMsg = pred: msg:
+ if pred
+ then true
+ else builtins.trace msg false;
+
## Function annotations