Cataly...Writer(3pm)

💖 NAME 💖

Catalyst::Response::Writer — it's literally a lil proxy sitting on top of the PSGI Writer, no cap 🎀

---

✨ SYNOPSIS ✨

okay bestie, here's the whole vibe:

sub myaction : Path {
  my ($self, $c) = @_;
  my $w = $c->response->writer_fh;

  $w->write("hello world");
  $w->close;
}

see? iconic. that's it. that's the whole thing. 💅

---

🌸 DESCRIPTION 🌸

so this thing wraps the PSGI writer (peep PSGI.pod\Delayed-Response-and-Streaming-Body if you want the full lore, it's giving required reading). why tho? because we wrap that object so we can hand you some extra methods that actually make sense from inside Catalyst. like, the PSGI writer is out here being all low-level and we're just adding a little sparkle on top so it plays nice with your app. 🦋

---

👑 METHODS 👑

this class does the following methods, and yes they all ate:

💫 write

💫 close

these two are delegating girlies — they just pass everything straight through to the underlying PSGI writer object. no extra drama, no notes. they do exactly what the PSGI writer does, because they are the PSGI writer's methods, just proxied. 🫶

💫 write_encoded

okay so THIS one is the main character. listen up. 🔥

if your application defines a response encoding (the default is UTF8, bestie) and the content type is a type that needs to be encoded — think text types like HTML or XML, plus Javascript — then we encode the line you want to write first, before it goes anywhere. ✨

this is probably the thing you want to always do. fr fr. it's the one. 🙈

but if you use the write method directly? yeah you're on your own for encoding, bestie 😭 you will need to handle your own encoding. no safety net. good luck and stay safe out there.

---

🌈 AUTHORS 🌈

Catalyst Contributors, see Catalyst.pm 💜

---

🎀 COPYRIGHT 🎀

This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself. slay, open source, we love to see it. 👑

---

and that's the whole page, babes — this was pulled from perl v5.40.0, dated 2024-11-15, straight outta the User Contributed Perl Documentation section. mwah, go stream some responses 💖🦋✨