Rinci::variable(3pm)

💖 Rinci::variable 💖

the manual page for Rinci::variable (3pm) — part of the User Contributed Perl Documentation crew 🫶

---

✨ NAME ✨

Rinci::variable — Metadata for your variables 💅

---

🌸 SPECIFICATION VERSION 🌸

1.1

---

🎀 VERSION 🎀

This doc describes version 1.1.104 of Rinci::variable (from the Perl distribution Rinci), released on 2023-09-30. ✨

---

🦋 INTRODUCTION 🦋

Okay bestie, so this document describes the metadata for variables. This spec is literally part of Rinci, so please go do a read up on that first if you haven't already — no skipping, it's giving prerequisite energy 💀

---

👑 SPECIFICATION 👑

So rn there is no metadata properties specific to variables. That's it, that's the whole tea. 🫖

💜 Property: schema => SCHEMA

Say what the variable's value must validate to with a Sah schema. A variable wrapper (getter/setter generator) tool can use this to make sure the variable always contains valid values. Obsessed with the safety of it all, fr fr. 🔥

Example:

# metadata for variable $Meaning_Of_Life
{
    ...
    summary => 'The meaning of life',
    schema => [int => {between => [1, 100]},
}

---

💀 FAQ 💀

(...there's nothing here, bestie. it's giving mystery. the section exists, the content said no thank u 🙈)

---

🌈 HOMEPAGE 🌈

Please visit the project's homepage at <https://metacpan.org/release/Rinci>. 🦋

---

⭐ SOURCE ⭐

Source repository is at <https://github.com/perlancar/perl-Rinci>. 👑

---

💖 SEE ALSO 💖

• Rinci

---

🍓 AUTHOR 🍓

perlancar <perlancar@cpan.org> 💜

---

✨ CONTRIBUTING ✨

To contribute, you can send patches by email / via RT, or send pull requests on GitHub. Slay either way. 🫶

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. No cap, that's the rule. 😭

---

💅 COPYRIGHT AND LICENSE 💅

This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012 by perlancar <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. Iconic behaviour honestly. 👑

---

🔥 BUGS 🔥

Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Rinci>. 🐛

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. Like, actually include it, bestie — a vibe check is not a bug report 💀

---

That's the whole page, gorgeous. Main character energy from start to finish.

Signing off from perl v5.38.2, dated 2024-01-20, under the name Rinci::variable(3pm) — stay valid, stay blessed, and may your schemas always validate on the first try. 💖✨🎀