---
name: "Plucene::Index::FieldsReader"
section: "3pm"
platform: "linux"
package: "libplucene-perl"
version: "1.25-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Plucene::Index::FieldsReader"
---

# Plucene::Index::FieldsReader(3pm)

read Fields in a Document

## NAME

Plucene::Index::FieldsReader - read Fields in a Document

## SYNOPSIS

```
        my $reader = Plucene::Index::FieldsReader->new(
                $dir_name, $segment, $field_infos);
        my Plucene::Document $doc = $reader->doc($offset);
        my $size = $reader->size;
```

## DESCRIPTION

This class gives access to documents within the index.

## METHODS

### new

```
        my $reader = Plucene::Index::FieldsReader->new(
                $dir_name, $segment, $field_infos);
```

This will create a new Plucene::Index::FieldsReader with the passed in  directory name, segment and field infos.

### size

```
        my $size = $reader->size;
```

This returns the size.

### doc

```
        my Plucene::Document $doc = $reader->doc($offset);
```

This will return the Plucene::Document object found at the passed in position.
