Forest...tructor(3pm)

💖 Forest::Tree::Constructor — the vibe ✨

okay so bestie, this page lives in the User Contributed Perl Documentation section, and the module itself goes by Forest::Tree::Constructor (the man page header is a little cutesy and abbreviates it to Forest...tructor(3pm) — she's shy, it's fine 🎀). It's a Perl role, and we're about to get into it. grab a snack. 🍓

---

✨ NAME ✨

Forest::Tree::Constructor — an abstract role for tree factories. no cap, that's the whole job description. 🌳

---

🦋 SYNOPSIS 🦋

here's the whole thing, verbatim, because I would never do you dirty like that:

with qw(Forest::Tree::Constructor);

sub tree_class { ... }

sub foo {
    $self->create_new_subtree( ... )
}

see how tree_class is just sitting there being ...? yeah. you gotta fill that in yourself, bestie. that's the whole assignment. 💅

---

🌸 DESCRIPTION 🌸

so this role hands you the create_new_subtree method — like, it's the one thing it does and she does it well. 👑

and why does anything need that method? because these two are out here being demanding:

• Forest::Tree::Builder
• Forest::Tree::Loader / Forest::Tree::Reader

they require create_new_subtree, so if you're gonna play in their sandbox you need this role. it's giving "required prerequisite", fr fr.

the docs lowkey point you at Forest::Tree::Builder for the recommended usage — that's where the good example lives, so go look there if you want to actually see it in action. (yes, the original spells it "reccomended". we respect the typo. it's iconic. 🙈)

---

💀 BUGS 💀

all complex software has bugs lurking in it, and this module is no exception. that's just how it is. every big pretty codebase has a gremlin in the basement.

if you find one, you've got two options:

1. email the author, or
2. add the bug to cpan-RT (the CPAN request tracker).

pick your fighter. either way, report it, don't just suffer in silence. 🫶

---

👑 AUTHOR 👑

Yuval Kogman — the mastermind, the main character, the one who wrote all this. ⭐

---

🌈 COPYRIGHT AND LICENSE 🌈

Copyright 2008-2014 Infinity Interactive, Inc.

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. so yes, it's free, yes you can share it, just keep the same terms as Perl and we're all good. 💜

---

and that's the page!! slay. 🎀

perl v5.34.0 · 2022-06-14 · and yeah, the footer is out here calling it Forest...tructor(3pm) again — she's consistent, I'll give her that. bye bestie, go build some trees 🌳✨💖