Perinc...etadata(3pm)

💖 Perinci::Object::Metadata — the manual, but make it a group chat 💖

okay so bestie, you're looking at Perinci::Object::Metadata(3pm) from the Perl world. It's the base class for the Perinci::Object metadata classes, so like… everything else in that family is basically its little sibling. periodt.

---

✨ NAME ✨

Perinci::Object::Metadata — it's the base class for the Perinci::Object metadata classes 🎀

---

🦋 VERSION 🦋

This doc is describing version 0.311 of Perinci::Object::Metadata (and yes, it's from the Perl distribution called Perinci-Object), released on 2020-01-02. she's a lil vintage, she's still iconic 💅

---

👑 METHODS 👑

okay here's the whole menu, no skips, no skims, we're doing all of them fr fr 🫶

🎀 new => obj

Constructor. that's it, that's the vibe — it makes a new object ✨

🎀 v => float

Get the version. just the number, bestie 💜

🎀 as_struct => hash

Get the underlying data structure. like, the raw thing under the cute wrapper 🍓

🎀 type => str

Return the type — e.g. "function", "package" 👑 she's telling you what she is, main character energy

🎀 langprop([ \%opts, ]$prop[, $new_value])

Get or set a property value in a specific language. To be precise: it looks at either the "prop" property, or the "prop.alt.lang.XXX" properties. multilingual queen 🌈

Known options (yes we're listing all of them):

• lang => STR — defaults to the metadata's "default_lang", which in turn defaults to "en_US" if nobody specified anything. so if you're silent about it, it assumes "en_US", no cap 💀
• mark_different_lang => BOOL (defaults to 1) — if you set this to true, text in a different language than the one you asked for gets marked. The example from the source: you ask for "I love you" in Indonesian but there's no Indonesian value available, so what comes back is "{en_US I love you}" — flagged, labeled, called out 🙈 it's giving "we don't have that translation so here's the one we got, clearly tagged"

🎀 name([ $new_value ]) => $value

Get or set the "name" property. Heads up: it will call "langprop()" for you 🫶

🎀 summary([ $new_value ]) => $value

Get or set the "summary" property. Also calls "langprop()" ✨

🎀 description([ $new_value ]) => $value

Get or set the "description" property. Yep — "langprop()" again 💅

🎀 caption([ $new_value ]) => $value

Get or set the "caption" property. And yes bestie, "langprop()" once more 🌸

ngl the pattern is: all four of those property methods ride on langprop(). that's the whole bit, and honestly? slay.

---

🌟 HOMEPAGE 🌟

The project's homepage lives at <https://metacpan.org/release/Perinci-Object>. go visit her, she'd love that 🦋

---

🧚 SOURCE 🧚

The source repo is at <https://github.com/perlancar/perl-Perinci-Object>. it's right there, lowkey iconic 🎀

---

💀 BUGS 💀

Found a bug? Got a feature request? Please report it on the bugtracker: <https://github.com/perlancar/perl-Perinci-Object/issues> 🙈

And when you submit a bug or a request, please include a test-file or a patch to an existing test-file that shows the bug or the desired feature. not me asking you to actually reproduce it — yes i am, do it, it helps so much 😭🫶

---

💜 AUTHOR 💜

perlancar <perlancar@cpan.org> — the legend themselves 👑

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2021, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. so like, go wild, but respectfully 💖

---

and that's the whole page bestie — every option, every default, every method, nothing skipped 😤 This was Perinci::Object::Metadata, documented as part of perl v5.36.0, dated 2022-10-13, and yeah — the header and footer both truncate the name to Perinc...etadata(3pm) because the terminal ran out of room, and honestly? relatable. she doesn't need the whole name to know who she is 💅✨