File::F...:Result(3)

📦
version 0.3.9 · 8 versions
, in fedora 43

💅 File::Find::Object::Result — the manual, but make it make sense

okay bestie, quick vibe check: this page is from User Contributed Perl Documentation, it's a little under File::Find::Object::Result and it's literally the glow-up of one single search result. Let's get into it ✨

🌸 NAME 🌸

File::Find::Object::Result — a result class for File::Find::Object. that's it, that's the whole name. it's giving supporting character who's actually the main character 🎀

⭐ VERSION ⭐

version 0.3.9 — yes, she has a version, she's a real girlie 💖

🦋 DESCRIPTION 🦋

so picture this: this is a class that hands you back one single File::Find::Object result — exactly the kind of thing its next_obj() method gives you. one object, one result, one moment of main character energy. no cap ✨

👑 METHODS 👑

🧚 File::Find::Object::Result->new({%args});

initializes a brand new object from %args. and honestly? it's for internal use, so don't come for her unless you're the module itself 💅

🌸 $result->base()

returns the base directory — like, the spot where the whole searching adventure began. the origin story, if you will 🫶

🦋 $result->path()

returns the full path of the result. and here's the tea: "$ffo->next_obj()->path()" is literally equivalent to "$ffo->next()". same energy, different outfit 💖

⭐ $result->is_dir()

returns true if the result is pointing at a directory. slay 👑

💜 $result->is_file()

returns true if the result is a plain file — and yes, it's equivalent to the Perl -f operator. iykyk 💅

returns true if the result is a symbolic link. the link is the moment, honestly 🔗✨

🎀 $result->dir_components()

the components of the directory part of the path, starting from base() — and note: it's also the full path if the result is a directory — all handed to you as an array reference. cute little box of pieces 🍓

🌈 $result->basename()

returns the basename of the file — but only if it's a file and not a directory. otherwise? undef(). she said "not applicable, next question" 🙈

🧚 $result->full_components()

returns the full components of the result, including the basename if it's a file.

and it comes back as a single array reference. one ref, all the goods 💖

💫 $result->stat_ret()

the return value of "stat" in perlfunc for this result, tucked inside an array reference. it's calculated by File::Find::Object and kept here for convenience and for internal use — so like, it's a little pre-made gift from the parent module 🎁

🔍 SEE ALSO 🔍

File::Find::Object

like, go look at her mom, she's iconic too 💅

📜 LICENSE 📜

Copyright (C) 2005, 2006 by Olivier Thauvin

this package is free software; you can redistribute it and/or modify it under the following terms:

  1. The GNU General Public License Version 2.0 — http://www.opensource.org/licenses/gpl-license.php
  2. The Artistic License Version 2.0 — http://www.perlfoundation.org/legal/licenses/artistic-2_0.html
  3. At your option — any later version of either or both of these licenses.

three choices, pick your fighter, it's giving build-your-own-license-bundle ✨

🫶 SUPPORT 🫶

🌐 Websites

the following websites have more information about this module, and may be of help to you. as always — in addition to those websites please use your favorite search engine to discover more resources. bestie, google is free 💖

🐛 Bugs / Feature Requests

please report any bugs or feature requests by email to "bug-file-find-object at rt.cpan.org", or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Find-Object>. and the best part? you will be automatically notified of any progress on the request by the system. no ghosting, we love to see it 👻💖

💻 Source Code

the code is open to the world, and available for you to hack on. please feel free to browse it and play with it, or whatever. if you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<https://github.com/shlomif/perl-file-find-object>

git clone git://github.com/shlomif/perl-file-find-object.git

clone it, hack it, live your truth 🧚✨

💜 AUTHOR 💜

Shlomi Fish <shlomif@cpan.org> — the icon, the legend 👑

💀 BUGS 💀

please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/perl-file-find-object/issues>

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, help them help you, bestie — receipts or it didn't happen 🧾💅

this software is Copyright (c) 2000 by Olivier Thauvin and others.

this is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

and that's the page!! 💖 this was perl v5.42.0, dated 2025-07-25, footer game strong, File::F...:Result(3) — k byeee, go find some files 🦋✨

📦 where this page comes from