{
    "content": [
        {
            "type": "text",
            "text": "# Plucene::Index::SegmentsReader (perldoc)\n\n## NAME\n\nPlucene::Index::SegmentsReader - reads the segments\n\n## SYNOPSIS\n\nmy $segsreader = Plucene::Index::SegmentsReader\n->new($dir, Plucene::Index::SegmentReader @readers);\nmy $numdocs = $segsreader->numdocs;\nmy $doc = $segsreader->document($id);\nmy $norms = $segreader->norms($field);\nmy $docfreq = $segsreader->docfreq($term);\nmy Plucene::Index::SegmentsTermEnum $termenum\n= $segsreader->terms($term);\nmy Plucene::Index::SegmentsTermDocs $termdocs\n= $segsreader->termdocs;\nmy Plucene::Index::SegmentsTermPositions $termpositions\n= $segsreader->termpositions;\nif ($segsreader->isdeleted($id)) { ... }\n\n## DESCRIPTION\n\nThis is the segments reader class.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Plucene::Index::SegmentsReader",
        "section": "",
        "mode": "perldoc",
        "summary": "Plucene::Index::SegmentsReader - reads the segments",
        "synopsis": "my $segsreader = Plucene::Index::SegmentsReader\n->new($dir, Plucene::Index::SegmentReader @readers);\nmy $numdocs = $segsreader->numdocs;\nmy $doc = $segsreader->document($id);\nmy $norms = $segreader->norms($field);\nmy $docfreq = $segsreader->docfreq($term);\nmy Plucene::Index::SegmentsTermEnum $termenum\n= $segsreader->terms($term);\nmy Plucene::Index::SegmentsTermDocs $termdocs\n= $segsreader->termdocs;\nmy Plucene::Index::SegmentsTermPositions $termpositions\n= $segsreader->termpositions;\nif ($segsreader->isdeleted($id)) { ... }",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 17,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 48,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Plucene::Index::SegmentsReader - reads the segments\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "my $segsreader = Plucene::Index::SegmentsReader\n->new($dir, Plucene::Index::SegmentReader @readers);\n\nmy $numdocs = $segsreader->numdocs;\nmy $doc = $segsreader->document($id);\nmy $norms = $segreader->norms($field);\nmy $docfreq = $segsreader->docfreq($term);\n\nmy Plucene::Index::SegmentsTermEnum $termenum\n= $segsreader->terms($term);\nmy Plucene::Index::SegmentsTermDocs $termdocs\n= $segsreader->termdocs;\nmy Plucene::Index::SegmentsTermPositions $termpositions\n= $segsreader->termpositions;\n\nif ($segsreader->isdeleted($id)) { ... }\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This is the segments reader class.\n",
                "subsections": []
            },
            "METHODS": {
                "content": "new\nmy $segsreader = Plucene::Index::SegmentsReader\n->new($dir, Plucene::Index::SegmentReader @readers);\n\nThis will create a new Plucene::Index::SegmentsReader object with the passed directory and\nPlucene::Index::SegmentReader objects.\n\nnumdocs\nmy $numdocs = $segsreader->numdocs;\n\nThis will return the number of documents in all the segments in the Reader.\n\ndocument\nmy $doc = $segsreader->document($id);\n\nThis will return the document at the passed document id.\n\nisdeleted\nif ($segsreader->isdeleted($id)) { ... }\n\nnorms\nmy $norms = $segreader->norms($field);\n\nThis returns the norms for the passed field.\n\nterms\nmy Plucene::Index::SegmentsTermEnum $termenum\n= $segsreader->terms($term);\n\nThis will return the Plucene::Index::SegmentsTermEnum onject for the passed in term.\n\ndocfreq\nmy $docfreq = $segsreader->docfreq($term);\n\nThis returns the number of documents containing the passed term.\n\ntermdocs\nmy Plucene::Index::SegmentsTermDocs $termdocs\n= $segsreader->termdocs;\n\nThis will return the Plucene::Index::SegmentsTermDocs object.\n\ntermpositions\nmy Plucene::Index::SegmentsTermPositions $termpositions\n= $segsreader->termpositions;\n\nThis will return the Plucene::Index::SegmentsTermPositions object.\n",
                "subsections": []
            }
        }
    }
}