End(3pm)

✨ End(3pm) ✨

okay bestie so this is End(3pm), a lil Perl module from the User Contributed Perl Documentation corner of the world, and it's literally just "generalized END {}" energy 💅

---

🌸 NAME 🌸

End — generalized END {}. that's it, that's the whole name, short and iconic 👑

---

🎀 SYNOPSIS 🎀

use End;

{  my $foo = end {print "Leaving the block\n"};
   ...
   last;    # prints "Leaving the block\n".
   ...
}

see how it just… runs when you leave the block? no cap, it's giving cleanup-on-the-way-out 🦋

---

💖 DESCRIPTION 💖

The module End exports a single subroutine end, and what it does is let you set up some code that gets run whenever the current block is exited — doesn't matter why you're leaving either. It fires for return, next, last, redo, exit, die, goto, or just… casually reaching the end of the block like a normal person walking out the door 🚪✨

Now to be more precise (iykyk, the details matter): end returns an object, and that object executes the code when the object is destroyed — a.k.a. when the variable you assigned it to goes out of scope. If that variable is lexical to the current block, then the code runs when you leave the block. periodt 💅

You can also force premature execution of the code if you want — just undefine the variable you assigned to, or assign another value to it. girl, that variable has main character energy and the code dies the moment it stops being the one 🫶

And heads up: end only takes one argument, and it's a code reference. If you want that code reference to take arguments? Just wrap the code reference in a closure, bestie, that's the move 🌈

---

💀 BUGS 💀

okay so there's a Perl 5.6.0 situation and we need to talk about it 😭

Due to a bug in Perl 5.6.0 (and perhaps before), anonymous subroutines that are not a closure will not go out of scope — not even on program termination. That's literally why end wraps the code fragment in a closure. so it's not a vibe choice, it's a survival tactic 🙈

There is a second bug in Perl 5.6.0 (and perhaps before) why this is necessary: if the code fragment isn't wrapped in another code reference, the original subroutine will be blessed in the package, making that ref on that code no longer return the right value. yeah. two bugs. perl 5.6.0 was going through something 💀

---

🌟 DEVELOPMENT 🌟

The current sources of this module are found on github, <git://github.com/Abigail/end.git>. go look, go star, go feel something 🧚

---

👑 AUTHOR 👑

This package was written by Abigail, <mailto:cpan@abigail.be> 💜 absolute legend behavior.

---

📜 COPYRIGHT & LICENSE 📜

Copyright (C) 2000 - 2009, Abigail

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 AUTHOR 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.

👆 yeah that's the whole license, every word, no skimming, we respect the paperwork in this house 🎀

---

and that's the whole page bestie!! 🦋💖 this was End(3pm) brought to you by perl v5.36.0, dated 2022-10-13 — mwah, see you at the next manpage, love u, bye 💅✨🌸