File Coverage

blib/lib/Search/OpenSearch/Feed.pm

Criterion	Covered	Total	%
statement	9	9	100.0
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod			n/a
total	12	12	100.0

package Search::OpenSearch::Feed;
use Moo;
use Types::Standard qw( HashRef ArrayRef Int Str Num Maybe );
use Carp;

our $VERSION = '0.101';

has 'entries'     => ( is => 'rw', isa => ArrayRef );
has 'total'       => ( is => 'rw', isa => Int );
has 'facets'      => ( is => 'rw', isa => Maybe[HashRef] );
has 'page_size'   => ( is => 'rw', isa => Int );
has 'offset'      => ( is => 'rw', isa => Int, default => sub {0} );
has 'query'       => ( is => 'rw', isa => Maybe[Str] );
has 'id'          => ( is => 'rw', isa => Str );
has 'title'       => ( is => 'rw', isa => Str );
has 'build_time'  => ( is => 'rw', isa => Maybe[Num] );
has 'search_time' => ( is => 'rw', isa => Maybe[Num] );
has 'suggestions' => ( is => 'rw', isa => Maybe[HashRef] );
has 'updated'     => ( is => 'rw', isa => Str );

=head1 NAME

Search::OpenSearch::Feed - client-side representation of a Search::OpenSearch::Response::XML

=head1 SYNOPSIS

 my $feed = Search::OpenSearch::FeedParser->new->parse( $sos_response_xml );
 printf("total: %s\n", $feed->total);
 for my $entry (@{ $feed->entries }) {
     printf(" uri: %s\n", $entry->{uri});
 }

=head1 DESCRIPTION

Search::OpenSearch::Feed represents the parsed response from Search::OpenSearch::Response::XML.
See L.

=head1 METHODS

The following attributes are available:

=head2 entries

=head2 total

=head2 facets

=head2 page_size

=head2 offset

=head2 query

=head2 id

=head2 title

=head2 build_time

=head2 search_time

=head2 suggestions

=head2 updated

=cut

1;

__END__