{
    "content": [
        {
            "type": "text",
            "text": "# POE::Filter::RecordBlock (perldoc)\n\n## NAME\n\nPOE::Filter::RecordBlock - translate between discrete records and blocks of them\n\n## SYNOPSIS\n\nHello, dear reader. This SYNOPSIS does not contain a fully functioning sample program because\nyour humble documenter cannot come up with a short, reasonable use case for this module. Please\ncontact the maintainer if this module is useful to you. Otherwise you may wake up one morning to\ndiscover that it has been deprecated.\n$filter = new POE::Filter::RecordBlock( BlockSize => 4 );\n$arrayrefofarrayrefs = $filter->get($arrayrefofrawdata);\n$arrayrefofrawchunks = $filter->put($arrayrefofarrayrefs);\n$arrayrefofrawchunks = $filter->put($singlearrayref);\n$arrayrefofleftovers = $filter->getpending;\n$arrayrefofleftovers = $filter->putpending;\n\n## DESCRIPTION\n\nOn input, POE::Filter::RecordBlock translates a stream of discrete items into a \"block\" of them.\nIt does this by collecting items until it has BlockSize of them, then returning the lot of them\nin an array reference.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **PUBLIC FILTER METHODS** (4 subsections)\n- **SEE ALSO**\n- **BUGS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "POE::Filter::RecordBlock",
        "section": "",
        "mode": "perldoc",
        "summary": "POE::Filter::RecordBlock - translate between discrete records and blocks of them",
        "synopsis": "Hello, dear reader. This SYNOPSIS does not contain a fully functioning sample program because\nyour humble documenter cannot come up with a short, reasonable use case for this module. Please\ncontact the maintainer if this module is useful to you. Otherwise you may wake up one morning to\ndiscover that it has been deprecated.\n$filter = new POE::Filter::RecordBlock( BlockSize => 4 );\n$arrayrefofarrayrefs = $filter->get($arrayrefofrawdata);\n$arrayrefofrawchunks = $filter->put($arrayrefofarrayrefs);\n$arrayrefofrawchunks = $filter->put($singlearrayref);\n$arrayrefofleftovers = $filter->getpending;\n$arrayrefofleftovers = $filter->putpending;",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 12,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 9,
                "subsections": []
            },
            {
                "name": "PUBLIC FILTER METHODS",
                "lines": 3,
                "subsections": [
                    {
                        "name": "new",
                        "lines": 7
                    },
                    {
                        "name": "put_pending",
                        "lines": 5
                    },
                    {
                        "name": "blocksize",
                        "lines": 1
                    },
                    {
                        "name": "checkput",
                        "lines": 1
                    }
                ]
            },
            {
                "name": "SEE ALSO",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 12,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "POE::Filter::RecordBlock - translate between discrete records and blocks of them\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "Hello, dear reader. This SYNOPSIS does not contain a fully functioning sample program because\nyour humble documenter cannot come up with a short, reasonable use case for this module. Please\ncontact the maintainer if this module is useful to you. Otherwise you may wake up one morning to\ndiscover that it has been deprecated.\n\n$filter = new POE::Filter::RecordBlock( BlockSize => 4 );\n$arrayrefofarrayrefs = $filter->get($arrayrefofrawdata);\n$arrayrefofrawchunks = $filter->put($arrayrefofarrayrefs);\n$arrayrefofrawchunks = $filter->put($singlearrayref);\n$arrayrefofleftovers = $filter->getpending;\n$arrayrefofleftovers = $filter->putpending;\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "On input, POE::Filter::RecordBlock translates a stream of discrete items into a \"block\" of them.\nIt does this by collecting items until it has BlockSize of them, then returning the lot of them\nin an array reference.\n\nOn output, this module flattens array references.\n\nThis module may be deprecated in the future. Please contact the maintainer if this module is\nuseful to you.\n",
                "subsections": []
            },
            "PUBLIC FILTER METHODS": {
                "content": "In addition to the usual POE::Filter methods, POE::Filter::RecordBlock supports the following.\n\nnew",
                "subsections": [
                    {
                        "name": "new",
                        "content": "zero. new() also accepts a CheckPut Boolean parameter that indicates whether put() should check\nfor the proper BlockSize before allowing data to be serialized.\n\nUsing CheckPut is not recommended, as it enables a write buffer in the filter, therefore\nbreaking put() for normal use.\n\nputpending"
                    },
                    {
                        "name": "put_pending",
                        "content": "equivalent of POE::Filter's getpending() accessor. putpending() is not part of the canonical\nPOE::Filter API, so nothing will use it. It's up to applications to handle pending output,\nwhenever it's appropriate to do so.\n\nblocksize"
                    },
                    {
                        "name": "blocksize",
                        "content": "checkput"
                    },
                    {
                        "name": "checkput",
                        "content": ""
                    }
                ]
            },
            "SEE ALSO": {
                "content": "POE::Filter for more information about filters in general.\n\nPOE::Filter::Stackable for more details on stacking filters.\n",
                "subsections": []
            },
            "BUGS": {
                "content": "This filter may maintain an output buffer that no other part of POE will know about.\n\nThis filter implements a highly specialized and seemingly not generally useful feature.\n\nDoes anyone use this filter? This filter may be deprecated if nobody speaks up.\n\nAUTHORS & COPYRIGHTS\nThe RecordBlock filter was contributed by Dieter Pearcey. Documentation is provided by Rocco\nCaputo.\n\nPlease see the POE manpage for more information about authors and contributors.\n",
                "subsections": []
            }
        }
    }
}