Messag...Filter(3pm)

✨ Message::Passing::Role::Filter ✨

okay so bestie, this is a page from the User Contributed Perl Documentation set, and it's all about Message::Passing::Role::Filter 💖 a simple abstraction for filtering messages. It's a role, so you don't use it directly — you wear it, like a cute little jacket for your own filter class 🧥✨

---

🎀 SYNOPSIS 🎀

Like, here's the whole vibe of how you'd use it:

package My::Filter;
use Moo;
use namespace::clean -except => 'meta';

with 'Message::Passing::Role::Filter';

sub filter {
    my ($self, $message) = @_;
    # Do something with $message
    return $message; # Or return undef to halt message!
}

1;

slay. That's it. That's the whole setup. 💅

---

🌸 DESCRIPTION 🌸

So this thing is both a producer AND a consumer of messages — main character energy, fr fr 👑 — and it's able to filter out messages based upon their contents, or permute the structure of messages. Basically it sits in the middle of your message chain and goes "hmm, do I let this one through, or do I shuffle it around a lil?" 🦋

---

💜 REQUIRED METHODS 💜

filter

This is the one you have to write, bestie. It gets called to filter the message, and it returns the mangled message — yes, "mangled", that's the actual word, iconic 💀

⚠️ IMPORTANT NOTE: if you return undef, then the message is not propagated further up the chain! Which, ngl, is actually super useful — that's how you filter out unwanted messages 🗑️✨

---

🦋 REQUIRED ATTRIBUTES 🦋

output_to

This one comes From Message::Passing::Role::Input. You don't define it here, you inherit the requirement, okay? 🫶

---

⭐ METHODS ⭐

consume

Consumes a message (it's giving hungry, honestly 🍓) and calls the filter method that you provided, passing in that message.

Then — in the case where the filter returns a message — it outputs the message to the next step in the chain ➡️💌

---

👀 SEE ALSO 👀

• Message::Passing
• Message::Passing::Manual::Concepts

iykyk, go read those next 💖

---

💖 SPONSORSHIP 💖

This module exists because of the wonderful people at Suretec Systems Ltd. <http://www.suretecsystems.com/> — they sponsored its development for their VoIP division, called SureVoIP <http://www.surevoip.co.uk/>, for use with the SureVoIP API:

<http://www.surevoip.co.uk/support/wiki/api_documentation>

Genuinely so sweet of them, we love a sponsor 🫶🌈

---

📜 AUTHOR, COPYRIGHT AND LICENSE 📜

See Message::Passing.

---

and that's the whole page, bestie!! This one shipped with perl v5.32.1 and the page itself is dated 2021-11-09 🎀 stay filtered, stay fabulous, mwah 💋✨