Data::...Filter(3pm)

πŸ“¦
version 0.11 Β· 5 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ’– Data::Stream::Bulk::Filter β€” the manual, but make it make sense πŸ’–

okay bestie, you found the page for Data::Stream::Bulk::Filter, which lives in the User Contributed Perl Documentation section of the manual (that's the 3pm part, iykyk). It's a Perl module, it's version 0.11, and it's about filtering streams. Let's get into it 🫢


✨ VERSION ✨

This is version 0.11. Slay.


🌸 SYNOPSIS 🌸

here's the vibe, literally just this:

use Data::Stream::Bulk::Filter;

Data::Stream::Bulk::Filter->new(
        filter => sub { ... },
        stream => $stream,
);

that's it. that's the whole entrance. iconic πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so like. this class implements filtering of streams. that's the whole thing. it filters streams. block oriented, streamed filtering. periodt ✨


πŸŽ€ ATTRIBUTES πŸŽ€

  • filter β€” the code reference you apply to each block. okay so the block gets passed to the filter both in $_ and as the first argument, so you can grab it either way, no cap. and here's the part you gotta pay attention to: the return value should be an array reference. if no true value comes back, the output stream does not end β€” instead an empty block gets substituted in its place. the parent stream is the one who decides when the stream is actually depleted, not you. so don't be out here thinking an empty return kills the stream, because it fr fr does not 😭
  • stream β€” the stream that's getting filtered. the one catching hands from filter, basically.

πŸ’œ METHODS πŸ’œ

  • is_done
  • loaded

both of these are delegated to stream. they don't do their own thing, they just pass the question along. teamwork, bestie 🀝

  • next β€” calls next on stream, and if a block came back, it applies filter to it. that's the whole method. short, sweet, ate πŸ‘‘

🌈 AUTHOR 🌈

Yuval Kogman <nothingmuch@woobling.org> β€” shoutout to the author, thank you for your service πŸ«‘πŸ’–


This software is copyright (c) 2012 by Yuval Kogman.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. so like, go wild, but respectfully 🌸


and that's the whole page, bestie!! this one was rendered with perl v5.32.0, dated 2021-01-01, and it's the Data::...Filter(3pm) page under User Contributed Perl Documentation. mwah, go filter something πŸ’‹βœ¨πŸ¦‹

πŸ“¦ where this page comes from