Net::SSH2::Dir(3)

💖 Net::SSH2::Dir — the manual page, but make it bestie 💖

okay so this is Net::SSH2::Dir, a page from the User Contributed Perl Documentation collection (that's the manual name, she's a user-contributed icon, we love her 🫶), and she's all about the SSH 2 SFTP directory object. no cap.

---

✨ NAME ✨

Net::SSH2::Dir — literally just the SSH 2 SFTP directory object. that's the whole vibe. 💅

---

🌸 DESCRIPTION 🌸

so here's the tea, bestie: an SFTP file object doesn't just appear out of nowhere. she's created by the Net::SSH2::SFTP opendir method. that's her origin story. that's her main character energy. 👑

---

🎀 METHODS 🎀

🦋 read 🦋

okay so read is the moment. she returns a hash — and if you're in scalar context, she hands you a hashref instead, because she's flexible like that.

the keys of that hash? they are:

• "name"
• and every key returned by Net::SSH2::SFTP::stat ✨

and if there are no more files? she gives you an empty list, or undef if you asked in scalar context. she's done. she's clocked out. 💀

---

👀 SEE ALSO 👀

• Net::SSH2::SFTP. go read that one too, she's the bestie that introduced us. 🫶

---

👑 AUTHOR 👑

David B. Robins, <dbrobins@cpan.org> — an absolute legend, we stan. 🌟

---

🌈 COPYRIGHT AND LICENSE 🌈

Copyright (C) 2005, 2006 by David B. Robins; all rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.0 or, at your option, any later version of Perl 5 you may have available. so basically, go off. 🎉

fr fr, keep the license intact — it's not a vibe, it's a requirement. 🫡

---

and that's the whole page, bestie!! 💖 this one came from perl v5.42.0 and it's dated 2025-07-25, filed under Net::SSH2::Dir(3) — slay, ate, no crumbs left. mwah. 💅✨🌈