/ 
MetaCPAN-Client-1.015000
River stage two • 29 direct dependents • 72 total dependents
/ MetaCPAN::Client::ResultSet

NAME

MetaCPAN::Client::ResultSet - A Result Set

VERSION

version 1.015000

DESCRIPTION

Object representing a result from Elastic Search. This is used for the complex (as in "MetaCPAN::Client/"SEARCH SPEC"" in non-simple) queries to MetaCPAN. It provides easy access to the scroller and facets.

ATTRIBUTES

scroller

An Search::Elasticsearch::Scroll object.

items

An arrayref of items to manually scroll over, instead of a scroller object.

type

The entity of the result set. Available types:

  • author

  • distribution

  • module

  • release

  • favorite

  • file

facets

The facets available in the Elastic Search response.

METHODS

next

Iterator call to fetch the next result set object.

total

Iterator call to fetch the total amount of objects available in result set.

has_scroller

Predicate for ES scroller presence.

BUILDARGS

Double checks construction of objects. You should never run this yourself.

AUTHORS

  • Sawyer X <xsawyerx@cpan.org>

  • Mickey Nasriachi <mickey@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Sawyer X.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.