String(3)

πŸ’– String(3) πŸ’–

🌸 NAME 🌸

This String(3) page is the user-contributed Perl documentation for XML::Writer::String β€” and its whole job is literally capturing output from XML::Writer. That's it. That's the vibe. πŸ’…

πŸ¦‹ SYNOPSIS πŸ¦‹

okay bestie, here's the exact code from the page β€” don't touch the punctuation, she's sensitive:

  use XML::Writer;
  use XML::Writer::String;

  my $s = XML::Writer::String->new();
  my $writer = new XML::Writer( OUTPUT => $s );

  $writer->xmlDecl();
  $writer->startTag('root');
  $writer->endTag();
  $writer->end();

  print $s->value();

✨ DESCRIPTION ✨

This module implements a bare-bones class specifically for the purpose of capturing data from the XML::Writer module. XML::Writer expects an IO::Handle object and writes XML data to the specified object (or STDOUT) via its print() method. This module simulates such an object for the specific purpose of providing the required print() method. 🫢

It is recommended that $writer->end() is called prior to calling $s->value() to check for well-formedness. important little vibe check, bestie. ✨

πŸŽ€ METHODS πŸŽ€

XML::Writer::String provides three methods β€” new(), print() and value():

  • $s = XML::Writer::String->new([list]); β€” new() returns a new String handle. Fresh handle, new era. πŸ’–
  • $count = $s->print([list]); β€” print() appends concatenated list data and returns the number of items in list. It's giving "collect the data, count the data." πŸ’…
  • $val = $s->value([list]); β€” value() returns the current content of the object as a scalar. It can also be used to initialize/overwrite the current content with concatenated list data. Iconic dual-purpose behaviour. ✨

🧚 NOTES 🧚

This module is designed for the specific purpose of capturing the output of XML::Writer objects, as described in this document. It does not inherit from IO::Handle. For an alternative solution, look at IO::Scalar, IO::Lines, IO::String or Tie::Handle::Scalar. πŸ¦‹

πŸ’Œ AUTHOR πŸ’Œ

Simon Oliver <simon.oliver@umist.ac.uk> 🫢

Copyright (C) 2002 Simon Oliver

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

🌈 SEE ALSO 🌈

XML::Writer, IO::Handle, IO::Scalar β€” go peek at these if you want the full lore. πŸ’œ


okay that's the whole page, bestie. this one's from perl v5.42.0, dated 2025-02-10, and it's the String(3) page β€” bye, slay, hydrate, and check your well-formedness. πŸ’…βœ¨πŸ«Ά

πŸ“¦ where this page comes from