HTTP::Link(3pm)

✨ NAME ✨

HTTP::Link — bestie, it's literally RFC5988 Web Linking, the whole thing, in Perl 💅

---

🌸 VERSION 🌸

version 0.001 — baby version, iconic debut era 🎀

---

💖 METHODS 💖

🦋 new

Returns a brand-new Web Link, as a string, slay ✨

my $link = HTTP::Link->new('/TheBook/Chapter/2',
    relation => 'next',
    title => 'next chapter',
);
# Result:
# </TheBook/Chapter/2>; rel="next"; title="next chapter"

Args, bestie:

• $iri — an internationalized resource identifier. It's the target uri reference, periodt.
• %options — extra parameters, keep reading 👇

Params for %options:

• "relation" — the possible relation types are: alternate, appendix, bookmark, chapter, contents, copyright, current, describedby, edit, edit-media, enclosure, first, glossary, help, hub, index, last, latest-version, license, next, next-archive, payment, prev, predecessor-version, previous, prev-archive, related, replies, section, self, service, start, stylesheet, subsection, successor-version, up, version-history, via, working-copy, working-copy-of and others (see IANA registry). Yeah, it's a whole list, we love an exhaustive moment 💀
• "extension" — an extension for a relation type.
• "anchor" — an anchor for the context IRI.
• "hreflang" — a hint telling you what the language of the destination's content is 🌈
• "media" — the intended destination medium, like in a CSS media query.
• "title" — a human-readable label. This one gets encoded with MIME::EcoEncode.
• "type" — a hint indicating the most possible MIME type of the destination's content.

🎀 rel

A shortcut method for new, but with a different signature — it's giving remix ✨

HTTP::Link->rel('/TheBook/Chapter/2',
    start => '/TheBook/Chapter/0'
);
# same as
HTTP::Link->new('/TheBook/Chapter/2',
    relation => 'start',
    extension => '/TheBook/Chapter/0',
);

Args:

• $iri — see new above, bestie.
• $relation — will be appended to %options by relation = $relation >> 💅
• $extension — will be appended to %options by extension = $extension >>
• %options — see new.

💜 multi

When you need more than one link, this is the method, no cap. It accepts a hash or a HashRef with a mapping of IRIs to options 🫶

HTTP::Link->multi(
    '/TheBook/Chapter/2' => {
        relation => 'previous'
    },
    '/TheBook/Chapter/4' => {
        relation => 'next'
    },
);
# Result:
# </TheBook/Chapter/2>; rel="previous", </TheBook/Chapter/4>; rel="next"

🧚 parse

Parses a Link-header field and returns all the founded links as a list of HashRefs 😭

my @links = HTTP::Link->parse(<<EOT);
</TheBook/Chapter/2>; rel="previous", </TheBook/Chapter/4>; rel="next"
EOT
# Result:
@links = ({
    iri => '/TheBook/Chapter/2',
    relation => 'previous'
},{
    iri => '/TheBook/Chapter/4',
    relation => 'next'
});

⭐ parse_hash

Parses a Link-header field and returns all the founded links as a HashRef with IRIs as key — same energy, different shape 💫

my %links = HTTP::Link->parse_hash(<<EOT);
</TheBook/Chapter/2>; rel="previous", </TheBook/Chapter/4>; rel="next"
EOT
# Result:
%links = (
    '/TheBook/Chapter/2' => {
        relation => 'previous'
    },
    '/TheBook/Chapter/4' => {
        relation => 'next'
    }
);

---

🔥 FUNCTIONS 🔥

• httplink_new — wrapper for HTTP::Link->"new"
• httplink_rel — wrapper for HTTP::Link->"rel"
• httplink_multi — wrapper for HTTP::Link->"multi"
• httplink_parse — wrapper for HTTP::Link->"parse"
• httplink_parse_hash — wrapper for HTTP::Link->"parse_hash"

---

🙈 BUGS 🙈

Please report any bugs or feature requests on the bugtracker website https://github.com/zurborg/libhttp-link-perl/issues

When you're submitting a bug or a request, please include a test-file or a patch to an existing test-file that illustrates the bug or the desired feature. Help us help you, bestie 🫶

---

👑 AUTHOR 👑

David Zurborg <zurborg@cpan.org>

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is Copyright (c) 2015 by David Zurborg.

This is free software, licensed under:

The ISC License

---

And that's the whole page, babes — this little doc dropped as part of perl v5.36.0, dated 2022-11-30, and you read the whole thing, main character energy fr fr 💅✨🎀