.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Data::HAL::Link 3pm" .TH Data::HAL::Link 3pm "2022-08-28" "perl v5.34.0" "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" Data::HAL::Link \- Hypertext Application Language link .SH "VERSION" .IX Header "VERSION" This document describes Data::HAL::Link version 1.001 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& map { +{ \& href => $_\->href\->uri\->as_string, \& rel => $_\->relation\->uri\->as_string \& } } @{ $resource\->links } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This section is completely quoted from the specification: .PP A Link Object represents a hyperlink from the containing resource to a \s-1URI.\s0 .SH "INTERFACE" .IX Header "INTERFACE" .SS "Composition" .IX Subsection "Composition" None. .SS "Constructors" .IX Subsection "Constructors" \fI\f(CI\*(C`new\*(C'\fI\fR .IX Subsection "new" .PP When the \*(L"deprecation\*(R" attribute is set, the constructor logs a Log::Any warning: .PP \&\f(CW\*(C`The link (relation: "%s", href: "%s") is deprecated, see <%s>\*(C'\fR .PP You can consume it with a Log::Any::Adapter of your choice, e.g. .PP .Vb 1 \& use Log::Any::Adapter \*(AqStderr\*(Aq; .Ve .PP Otherwise the constructor behaves like the default Moo constructor. Returns a \f(CW\*(C`Data::HAL::Link\*(C'\fR object. .SS "Attributes" .IX Subsection "Attributes" Perl strings are coerced to the Data::HAL::URI type in the attributes \*(L"relation\*(R", \*(L"href\*(R", \*(L"deprecation\*(R", \&\*(L"profile\*(R". .PP \fI\f(CI\*(C`relation\*(C'\fI\fR .IX Subsection "relation" .PP Type Data::HAL::URI, \fBrequired\fR, link relation .PP \fI\f(CI\*(C`href\*(C'\fI\fR .IX Subsection "href" .PP Type Data::HAL::URI, \fBrequired\fR, link target \s-1URI\s0 or \s-1URI\s0 template .PP \fI\f(CI\*(C`templated\*(C'\fI\fR .IX Subsection "templated" .PP Type boolean, whether \f(CW\*(C`href\*(C'\fR is a \s-1URI\s0 template .PP Perl boolean values are coerced to the boolean type. .PP \fI\f(CI\*(C`type\*(C'\fI\fR .IX Subsection "type" .PP Type MIME::Type, media type of the \f(CW\*(C`href\*(C'\fR resource .PP \fI\f(CI\*(C`deprecation\*(C'\fI\fR .IX Subsection "deprecation" .PP Type Data::HAL::URI, if existing indicates the link is deprecated .PP Setting the attribute triggers a log message in the constructor \*(L"new\*(R". .PP \fI\f(CI\*(C`name\*(C'\fI\fR .IX Subsection "name" .PP Type \f(CW\*(C`Str\*(C'\fR, secondary key for selecting link objects which share the same relation type .PP \fI\f(CI\*(C`profile\*(C'\fI\fR .IX Subsection "profile" .PP Type Data::HAL::URI, \&\s-1RFC 6906\s0 profile of the target resource .PP \fI\f(CI\*(C`title\*(C'\fI\fR .IX Subsection "title" .PP Type \f(CW\*(C`Str\*(C'\fR, labels the link with a human-readable identifier .PP \fI\f(CI\*(C`hreflang\*(C'\fI\fR .IX Subsection "hreflang" .PP Type \f(CW\*(C`Str\*(C'\fR, indicates the language of the target resource .SS "Methods" .IX Subsection "Methods" \fI\f(CI\*(C`as_http_link_value\*(C'\fI\fR .IX Subsection "as_http_link_value" .PP Returns the link as a \s-1RFC 5988\s0 \f(CW\*(C`link\-value\*(C'\fR string, e.g. \&\f(CW\*(C`;rel="next"\*(C'\fR. .SS "Exports" .IX Subsection "Exports" None. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" See \*(L"new\*(R" constructor. .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" Requires no configuration files or environment variables.