BufferText(3)

BufferText(3) 🦋✨

okay bestie, welcome to BufferText(3) from the User Contributed Perl Documentation corner of the internet. This is the manual page for XML::Filter::BufferText, a tiny Perl filter with main character energy and one very specific job. Slay. 💅

---

🌸 NAME 🌸

XML::Filter::BufferText — Filter to put all characters() in one event. That's the whole vibe. 🎀

✨ SYNOPSIS ✨

my $h = SomeHandler->new;
my $f = XML::Filter::BufferText->new( Handler => $h );
my $p = SomeParser->new( Handler => $f );
$p->parse;

🦋 DESCRIPTION 🦋

This is a very simple filter. Like, no drama, just buffering.

Here's the tea: one common cause of grief (and programmer error) is that XML parsers aren't required to provide character events in one chunk. They can, but are not forced to, and most don't. This filter does the trivial but oft-repeated task of putting all characters into a single event. Iconic behavior, honestly.

Note that this won't help you in cases such as:

<foo> blah <!-- comment --> phubar </foo>

In the above case, given the interleaving comment, there will be two character() events. This may be worked around in the future if there is demand for it.

An interesting way to use this filter, instead of telling users to use it, is to return it from your handler's constructor, already configured and all. That'll make the buffering totally transparent to them (XML::SAX::Writer does that). Obsessed. 🫶

💖 AUTHOR 💖

Robin Berjon, robin@knowscape.com

🎀 COPYRIGHT 🎀

Copyright (c) 2001-2002 Robin Berjon. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

🌈 SEE ALSO 🌈

• XML::SAX::*
• XML::Generator::*
• XML::Handler::*
• XML::Filter::*

---

signed off from the perl v5.42.0 era, dated 2012-01-11, still serving BufferText(3) realness 💜