XML::S...:Stream(3pm)

📦
version 0.27 · 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

💖 XML::S...:Stream — bestie's guide to the streamy SAX writer 💖

okay so first things first: this page is part of the User Contributed Perl Documentation (iykyk), and the class we're hyping up today is XML::Struct::Writer::Stream. the man page abbreviates it as XML::S...:Stream(3pm) because apparently even man pages have a character limit and it's giving ✨mysterious✨. anyway.

🌈 NAME 🌈

XML::Struct::Writer::Stream — a simplified SAX handler that serializes (Micro)XML. no cap, that's the whole job description 🎀

🦋 DESCRIPTION 🦋

so this class implements a simplified SAX handler for stream-based serialization of XML. it's the chill, low-maintenance version — it just writes your XML out as it goes. 🌊

but bestie, hear me loud: DTDs, comments, processing instructions and similar features that are not part of MicroXML are not supported. nope. not happening. if you were hoping for a DTD moment, this is not the class for you 💀. MicroXML only, periodt.

the handler is written to reproduce the serialization of libxml. that's the vibe it's going for — same output energy, no extra drama. 💅

✨ CONFIGURATION ✨

here's where you get to customize the whole situation:

  • fh — a file handle or compatible object to write to. and if you don't set it? it just writes to standard output by default. iconic, honestly 🫶
  • pretty — pretty-print the XML if enabled. turn this on and your XML gets that glow-up: indented, spaced out, main character formatting 🌸

👑 SEE ALSO 👑

want something with more going on? here are the other writers in the group chat:

  • XML::SAX::Writer, XML::Genx::SAXWriter, and XML::Handler::YAWriter — these are the more elaborated SAX writers. if you need fancier features, go say hi to them 💜
  • XML::Writer — a general XML writer, but heads up, it's not based on SAX. different approach, still valid 🦋
💌 little reminder: this page came from perl v5.28.1 and was dated 2019-02-21. shoutout to the era that brought us this one, we love her, we respect her, we cite her properly. mwah 😭💖
📦 where this page comes from