.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MetaCPAN::Client::Role::Entity 3pm"
.TH MetaCPAN::Client::Role::Entity 3pm 2024-03-24 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
MetaCPAN::Client::Role::Entity \- A role for MetaCPAN entities
.SH VERSION
.IX Header "VERSION"
version 2.031001
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a role to be consumed by all MetaCPAN::Client entities. It provides
common attributes and methods.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS data
.IX Subsection "data"
Hash reference containing all the entity data.
.PP
Entities are usually generated using \f(CW\*(C`new_from_request\*(C'\fR which sets the \f(CW\*(C`data\*(C'\fR
attribute appropriately by picking the relevant information.
.PP
Required.
.SH METHODS
.IX Header "METHODS"
.SS new_from_request
.IX Subsection "new_from_request"
Create a new entity object using a request hash. The hash represents the
information returned from a MetaCPAN request. This also sets the data attribute.
.SS BUILDARGS
.IX Subsection "BUILDARGS"
Perform type checks & conversion for the incoming data.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Sawyer X <xsawyerx@cpan.org>
.IP \(bu 4
Mickey Nasriachi <mickey@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Sawyer X.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.