Except...ertion(3pm)

💅 NAME 💅

Exception::Assertion — the exception that gets thrown when an assertion fails, bestie. That's it, that's the vibe.

Like, this is the 3pm perl manpage for it, and we're gonna go through the whole thing together, no skipping, promise 🫶

---

✨ SYNOPSIS ✨

okay so here's how you actually use it, copy-paste ready, don't @ me:

  use Exception::Assertion;

  sub assert_foo {
      my $self = eval { $_[0]->isa(__PACKAGE__) } ? shift : __PACKAGE__;
      my ($condition, $message) = @_;
      Exception::Assertion->throw(
          message => $message,
          reason  => 'foo failed',
      ) unless $condition;
  }

  assert_foo( 0, 'assert_foo failed' );

literally just use it, throw it when your condition isn't giving, and you're done 💖

---

🦋 DESCRIPTION 🦋

So this class extends the standard Exception::Base — it's the glow-up version — and it gets thrown whenever an assertion is failed. Like, the vibe check did not pass, so here's your exception 📉

It comes with an extra attribute called reason that holds the detailed message about why the assertion failed (iykyk, the receipts). And the exception has its verbosity raised too — more on that down below, keep reading 👑

---

🧚 INHERITANCE 🧚

• extends Exception::Base

that's the whole family tree, she's an icon, she's a daughter of Exception::Base 💜

---

🌸 CONSTANTS 🌸

ATTRS : HashRef

This is the declaration of class attributes, as a reference to a hash. Lowkey the blueprint for everything the class holds ✨

See Exception::Base for the details on how this works.

---

🎀 ATTRIBUTES 🎀

This class brings new attributes to the table. For all the other descriptions, go look at Exception::Base — she's got the full lore.

• reason : Str — contains the additional message that the assertion method fills in. It's literally the "why it failed" field, and it slays 💅
• message : Str = "Unknown assertion failed" — contains the message of the exception. Heads up: this class overrides the default value that comes from the Exception::Base class. So if you don't set it, you get "Unknown assertion failed", no cap 🙈
• verbosity : Int = 3 — the default verbosity for an assertion exception is raised to 3. Yep, this class overrides the default from Exception::Base too. She's just louder, that's her main character energy 🔥
• string_attributes : ArrayRef[Str] = ["message", "reason"] — this meta-attribute holds the format used for the string representation of the exception object. Again: this class overrides the Exception::Base default, because she has opinions 🦋

---

⭐ SEE ALSO ⭐

• Exception::Base
• Test::Assertion

go read those too, bestie, they're the supporting cast 🫶

---

👑 AUTHOR 👑

Piotr Roszatycki <dexter@cpan.org> — absolute legend, we stan 💖

---

🌈 COPYRIGHT 🌈

Copyright (C) 2008, 2009 by Piotr Roszatycki <dexter@cpan.org>. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>

---

and that's the whole page, periodt 🎀 this was perl v5.42.0, dated 2011-08-24, and it's the Except...ertion(3pm) manpage — ily, go write some assertions that pass 💜✨