---
name: "Lucy::Index::PostingListReader"
section: "3pm"
platform: "linux"
package: "liblucy-perl"
version: "0.3.3-7+b1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/Lucy::Index::PostingListReader"
---

# Lucy::Index::PostingListReader(3pm)

Read postings data.

## NAME

Lucy::Index::PostingListReader - Read postings data.

## SYNOPSIS

```
    my $posting_list_reader
        = $seg_reader->obtain("Lucy::Index::PostingListReader");
    my $posting_list = $posting_list_reader->posting_list(
        field => 'title',
        term  => 'foo',
    );
```

## DESCRIPTION

PostingListReaders produce PostingList objects which convey document matching information.

## ABSTRACT METHODS

### posting\_list( *\[labeled params\]* )

Returns a PostingList, or undef if either `"field"` is undef or `"field"` is not present in any documents.

- •

  **field** - A field name.

- •

  **term** - If supplied, the PostingList will be pre-located to this term using *seek()*.

## INHERITANCE

Lucy::Index::PostingListReader isa Lucy::Index::DataReader isa Lucy::Object::Obj.