{ "content": [ { "type": "text", "text": "# IO::Stringy (info)\n\n## NAME\n\nIO-stringy - I/O on in-core objects like strings and arrays\n\n## SYNOPSIS\n\nIO::\n::AtomicFile adpO Write a file which is updated atomically ERYQ\n::Lines bdpO I/O handle to read/write to array of lines ERYQ\n::Scalar RdpO I/O handle to read/write to a string ERYQ\n::ScalarArray RdpO I/O handle to read/write to array of scalars ERYQ\n::Wrap RdpO Wrap old-style FHs in standard OO interface ERYQ\n::WrapTie adpO Tie your handles & retain full OO interface ERYQ\n\n## DESCRIPTION\n\nThis toolkit primarily provides modules for performing both traditional\nand object-oriented i/o) on things other than normal filehandles; in\nparticular, IO::Scalar, IO::ScalarArray, and IO::Lines.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **WARNINGS**\n- **INSTALLATION**\n- **VERSION**\n- **TO DO**\n- **CHANGE LOG**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "IO::Stringy", "section": "", "mode": "info", "summary": "IO-stringy - I/O on in-core objects like strings and arrays", "synopsis": "IO::\n::AtomicFile adpO Write a file which is updated atomically ERYQ\n::Lines bdpO I/O handle to read/write to array of lines ERYQ\n::Scalar RdpO I/O handle to read/write to a string ERYQ\n::ScalarArray RdpO I/O handle to read/write to array of scalars ERYQ\n::Wrap RdpO Wrap old-style FHs in standard OO interface ERYQ\n::WrapTie adpO Tie your handles & retain full OO interface ERYQ", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 8, "subsections": [] }, { "name": "DESCRIPTION", "lines": 13, "subsections": [] }, { "name": "WARNINGS", "lines": 17, "subsections": [] }, { "name": "INSTALLATION", "lines": 31, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "TO DO", "lines": 15, "subsections": [] }, { "name": "CHANGE LOG", "lines": 187, "subsections": [] }, { "name": "AUTHOR", "lines": 22, "subsections": [] } ], "sections": { "NAME": { "content": "IO-stringy - I/O on in-core objects like strings and arrays\n", "subsections": [] }, "SYNOPSIS": { "content": "IO::\n::AtomicFile adpO Write a file which is updated atomically ERYQ\n::Lines bdpO I/O handle to read/write to array of lines ERYQ\n::Scalar RdpO I/O handle to read/write to a string ERYQ\n::ScalarArray RdpO I/O handle to read/write to array of scalars ERYQ\n::Wrap RdpO Wrap old-style FHs in standard OO interface ERYQ\n::WrapTie adpO Tie your handles & retain full OO interface ERYQ\n", "subsections": [] }, "DESCRIPTION": { "content": "This toolkit primarily provides modules for performing both traditional\nand object-oriented i/o) on things other than normal filehandles; in\nparticular, IO::Scalar, IO::ScalarArray, and IO::Lines.\n\nIn the more-traditional IO::Handle front, we have IO::AtomicFile which\nmay be used to painlessly create files which are updated atomically.\n\nAnd in the \"this-may-prove-useful\" corner, we have IO::Wrap, whose\nexported wraphandle() function will clothe anything that's not a\nblessed object in an IO::Handle-like wrapper... so you can just use OO\nsyntax and stop worrying about whether your function's caller handed\nyou a string, a globref, or a FileHandle.\n", "subsections": [] }, "WARNINGS": { "content": "Perl's TIEHANDLE spec was incomplete prior to 5.00557; it was missing\nsupport for \"seek()\", \"tell()\", and \"eof()\". Attempting to use these\nfunctions with an IO::Scalar, IO::ScalarArray, IO::Lines, etc. will not\nwork prior to 5.00557. None of the relevant methods will be invoked\nby Perl; and even worse, this kind of bug can lie dormant for a while.\nIf you turn warnings on (via $^W or \"perl -w\"), and you see something\nlike this...\n\nseek() on unopened file\n\n...then you are probably trying to use one of these functions on one of\nour IO:: classes with an old Perl. The remedy is to simply use the OO\nversion; e.g.:\n\n$SH->seek(0,0); ### GOOD: will work on any 5.005\nseek($SH,0,0); ### WARNING: will only work on 5.00557 and beyond\n", "subsections": [] }, "INSTALLATION": { "content": "Requirements\nAs of version 2.x, this toolkit requires Perl 5.005 for the IO::Handle\nsubclasses, and 5.00557 or better is strongly recommended. See\n\"WARNINGS\" for details.\n\nDirections\nMost of you already know the drill...\n\nperl Makefile.PL\nmake\nmake test\nmake install\n\nFor everyone else out there... if you've never installed Perl code\nbefore, or you're trying to use this in an environment where your\nsysadmin or ISP won't let you do interesting things, relax: since this\nmodule contains no binary extensions, you can cheat. That means\ncopying the directory tree under my \"./lib\" directory into someplace\nwhere your script can \"see\" it. For example, under Linux:\n\ncp -r IO-stringy-1.234/lib/* /path/to/my/perl/\n\nNow, in your Perl code, do this:\n\nuse lib \"/path/to/my/perl\";\nuse IO::Scalar; ### or whatever\n\nOk, now you've been told. At this point, anyone who whines about not\nbeing given enough information gets an unflattering haiku written about\nthem in the next change log. I'll do it. Don't think I won't.\n", "subsections": [] }, "VERSION": { "content": "$Id: Stringy.pm,v 1.3 2005/02/10 21:24:05 dfs Exp $\n", "subsections": [] }, "TO DO": { "content": "(2000/08/02) Finalize $/ support\nGraham Barr submitted this patch half a year ago; Like a moron, I\nlost his message under a ton of others, and only now have the\nexperimental implementation done.\n\nWill the sudden sensitivity to $/ hose anyone out there? I'm\nworried, so you have to enable it explicitly in 1.x. It will be on\nby default in 2.x, though only IO::Scalar has been implemented.\n\n(2001/08/08) Remove IO::WrapTie from new IO:: classes\nIt's not needed. Backwards compatibility could be maintained by\nhaving newtie() be identical to new(). Heck, I'll bet that\nIO::WrapTie should be reimplemented so the returned object is just\nlike an IO::Scalar in its use of globrefs.\n", "subsections": [] }, "CHANGE LOG": { "content": "Version 2.110 (2005/02/10)\nMaintainership taken over by DSKOLL \n\nClosed the following bugs at\nhttps://rt.cpan.org/NoAuth/Bugs.html?Dist=IO-stringy:\n\n2208 IO::ScalarArray->getline does not return undef for EOF if undef($/)\n7132 IO-stringy/Makefile.PL bug - name should be module name\n11249 IO::Scalar flush shouldn't return undef\n2172 $\\ (output record separator) not respected\n8605 IO::InnerFile::seek() should return 1 on success\n4798 *.html in lib/\n4369 Improvement: handling of fixed-size reads in IO::Scalar\n(Actually, bug 4369 was closed in Version 2.109)\n\nVersion 2.109 (2003/12/21)\nIO::Scalar::getline now works with ref to int. Thanks to Dominique\nQuatravaux for this patch.\n\nVersion 2.108 (2001/08/20)\nThe terms-of-use have been placed in the distribution file\n\"COPYING\". Also, small documentation tweaks were made.\n\nVersion 2.105 (2001/08/09)\nAdded support for various seek() whences to IO::ScalarArray.\n\nAdded support for consulting $/ in IO::Scalar and IO::ScalarArray.\nThe old \"useRS()\" is not even an option. Unsupported record\nseparators will cause a croak().\n\nAdded a lot of regression tests to supoprt the above.\n\nBetter on-line docs (hyperlinks to individual functions).\n\nVersion 2.103 (2001/08/08)\nAfter sober consideration I have reimplemented IO::Scalar::print()\nso that it once again always seeks to the end of the string.\nBenchmarks show the new implementation to be just as fast as\nJuergen's contributed patch; until someone can convince me\notherwise, the current, safer implementation stays.\n\nI thought more about giving IO::Scalar two separate handles, one\nfor reading and one for writing, as suggested by Binkley. His\npoints about what tell() and eof() return are, I think, show-\nstoppers for this feature. Even the manpages for stdio's fseek()\nseem to imply a single file position indicator, not two. So I\nthink I will take this off the TO DO list. Remedy: you can always\nhave two handles open on the same scalar, one which you only write\nto, and one which you only read from. That should give the same\neffect.\n\nVersion 2.101 (2001/08/07)\nAlpha release. This is the initial release of the \"IO::Scalar and\nfriends are now subclasses of IO::Handle\". I'm flinging it against\nthe wall. Please tell me if the banana sticks. When it does, the\nbanana will be called 2.2x.\n\nFirst off, many many thanks to Doug Wilson, who has provided an\ninvaluable service by patching IO::Scalar and friends so that they\n(1) inherit from IO::Handle, (2) automatically tie themselves so\nthat the \"new()\" objects can be used in native i/o constructs, and\n(3) doing it so that the whole damn thing passes its regression\ntests. As Doug knows, my globref Kung-Fu was not up to the task;\nhe graciously provided the patches. This has earned him a seat at\nthe Co-Authors table, and the right to have me address him as\nsensei.\n\nPerformance of IO::Scalar::print() has been improved by as much as\n2x for lots of little prints, with the cost of forcing those who\nprint-then-seek-then-print to explicitly seek to end-of-string\nbefore printing again. Thanks to Juergen Zeller for this patch.\n\nAdded the COPYING file, which had been missing from prior versions.\nThanks to Albert Chin-A-Young for pointing this out.\n\nIO::Scalar consults $/ by default (1.x ignored it by default).\nYes, I still need to support IO::ScalarArray.\n\nVersion 1.221 (2001/08/07)\nI threatened in \"INSTALLATION\" to write an unflattering haiku about\nanyone who whined that I gave them insufficient information... but\nit turns out that I left out a crucial direction. D'OH! Thanks to\nDavid Beroff for the \"patch\" and the haiku...\n\nEnough info there?\nHere's unflattering haiku:\nForgot the line, \"make\"! ;-)\n\nVersion 1.220 (2001/04/03)\nAdded untested SEEK, TELL, and EOF methods to IO::Scalar and\nIO::ScalarArray to support corresponding functions for tied\nfilehandles: untested, because I'm still running 5.00556 and Perl\nis complaining about \"tell() on unopened file\". Thanks to Graham\nBarr for the suggestion.\n\nRemoved not-fully-blank lines from modules; these were causing lots\nof POD-related warnings. Thanks to Nicolas Joly for the\nsuggestion.\n\nVersion 1.219 (2001/02/23)\nIO::Scalar objects can now be made sensitive to $/ . Pains were\ntaken to keep the fast code fast while adding this feature. Cheers\nto Graham Barr for submitting his patch; jeers to me for losing his\nemail for 6 months.\n\nVersion 1.218 (2001/02/23)\nIO::Scalar has a new sysseek() method. Thanks again to Richard\nJones.\n\nNew \"TO DO\" section, because people who submit patches/ideas should\nat least know that they're in the system... and that I won't lose\ntheir stuff. Please read it.\n\nNew entries in \"AUTHOR\". Please read those too.\n\nVersion 1.216 (2000/09/28)\nIO::Scalar and IO::ScalarArray now inherit from IO::Handle. I\nthought I'd remembered a problem with this ages ago, related to the\nfact that these IO:: modules don't have \"real\" filehandles, but the\nproblem apparently isn't surfacing now. If you suddenly encounter\nPerl warnings during global destruction (especially if you're using\ntied filehandles), then please let me know! Thanks to B. K. Oxley\n(binkley) for this.\n\nNasty bug fixed in IO::Scalar::write(). Apparently, the offset and\nthe number-of-bytes arguments were, for all practical purposes,\nreversed. You were okay if you did all your writing with print(),\nbut boy was this a stupid bug! Thanks to Richard Jones for finding\nthis one. For you, Rich, a double-length haiku:\n\nNewspaper headline\ntypeset by dyslexic man\nloses urgency\n\nBABY EATS FISH is\nsimply not equivalent\nto FISH EATS BABY\n\nNew sysread and syswrite methods for IO::Scalar. Thanks again to\nRichard Jones for this.\n\nVersion 1.215 (2000/09/05)\nAdded 'bool' overload to '\"\"' overload, so object always evaluates\nto true. (Whew. Glad I caught this before it went to CPAN.)\n\nVersion 1.214 (2000/09/03)\nEvaluating an IO::Scalar in a string context now yields the\nunderlying string. Thanks to B. K. Oxley (binkley) for this.\n\nVersion 1.213 (2000/08/16)\nMinor documentation fixes.\n\nVersion 1.212 (2000/06/02)\nFixed IO::InnerFile incompatibility with Perl5.004. Thanks to many\nfolks for reporting this.\n\nVersion 1.210 (2000/04/17)\nAdded flush() and other no-op methods. Thanks to Doru Petrescu for\nsuggesting this.\n\nVersion 1.209 (2000/03/17)\nSmall bug fixes.\n\nVersion 1.208 (2000/03/14)\nIncorporated a number of contributed patches and extensions, mostly\nrelated to speed hacks, support for \"offset\", and WRITE/CLOSE\nmethods. Thanks to Richard Jones, Doru Petrescu, and many others.\n\nVersion 1.206 (1999/04/18)\nAdded creation of ./testout when Makefile.PL is run.\n\nVersion 1.205 (1999/01/15)\nVerified for Perl5.005.\n\nVersion 1.202 (1998/04/18)\nNew IO::WrapTie and IO::AtomicFile added.\n\nVersion 1.110\nAdded IO::WrapTie.\n\nVersion 1.107\nAdded IO::Lines, and made some bug fixes to IO::ScalarArray. Also,\nadded getc().\n\nVersion 1.105\nNo real changes; just upgraded IO::Wrap to have a $VERSION string.\n", "subsections": [] }, "AUTHOR": { "content": "Primary Maintainer\nDianne Skoll (dfs@roaringpenguin.com).\n\nOriginal Author\nEryq (eryq@zeegee.com). President, ZeeGee Software Inc\n(http://www.zeegee.com).\n\nCo-Authors\nFor all their bug reports and patch submissions, the following are\nofficially recognized:\n\nRichard Jones\nB. K. Oxley (binkley)\nDoru Petrescu\nDoug Wilson (for picking up the ball I dropped, and doing tie() right)\n\nGo to http://www.zeegee.com for the latest downloads and on-line\ndocumentation for this module.\n\nEnjoy. Yell if it breaks.\n\nperl v5.28.1 2019-02-28 IO::Stringy(3pm)", "subsections": [] } } } }