Net::S...Compat(3pm)

✨ NAME ✨

Net::SFTP::Foreign::Compat — bestie, it's an Adapter for Net::SFTP compatibility 💖 (and yeah, it lives in the 3pm part of the manual, aka User Contributed Perl Documentation, so you're in the right place 🫶)

---

🌸 SYNOPSIS 🌸

okay so here's the whole vibe, literally just copy-paste energy:

    use Net::SFTP::Foreign::Compat;
    my $sftp = Net::SFTP::Foreign::Compat->new($host);
    $sftp->get("foo", "bar");
    $sftp->put("bar", "baz");

    use Net::SFTP::Foreign::Compat ':supplant';
    my $sftp = Net::SFTP->new($host);

see how the second one just... says Net::SFTP? that's the :supplant tag doing its thing, we'll get there 🦋

---

💅 DESCRIPTION 💅

So this package is a wrapper around Net::SFTP::Foreign that hands you an API that's (mostly) compatible with the API of Net::SFTP. that's it, that's the whole job. it's giving translator, it's giving bridge, it's giving "I got you bestie, you don't have to rewrite your code" 💖

The methods on this package are identical to the ones in Net::SFTP — with one teeny tiny exception: you gotta use Net::SFTP::Foreign::Attributes::Compat objects instead of Net::SFTP::Attributes. that's the one swap, no cap. 🔥

And now the iconic part: if you use the :supplant tag, this module also installs wrappers on the Net::SFTP and Net::SFTP::Attributes packages. which means? zero other parts of your program need to be modified in order to move from Net::SFTP to Net::SFTP::Foreign. no editing, no find-and-replace, no tears. main character migration energy 👑

---

🎀 Setting defaults 🎀

So there's this hash — %Net::SFTP::Foreign::DEFAULTS — and you can use it to set default values for Net::SFTP::Foreign methods that get called under the hood but are otherwise not accessible through the Net::SFTP API. sneaky? a little. useful? absolutely 💅

Here's the entries it currently supports:

• new => \@opts — extra options passed to the Net::SFTP::Foreign constructor. ✨
• get => \@opts — extra options passed to the Net::SFTP::Foreign::get method.
• put => \@opts — extra options passed to the Net::SFTP::Foreign::put method.
• ls => \@opts — extra options passed to the Net::SFTP::Foreign::ls method.

like, that's the whole list. four entries. short and slay 🌈

---

👑 COPYRIGHT 👑

Copyright (c) 2006-2008, 2011 Salvador Fandiño

All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

okay so real talk: that's the legal bit and you should not skip it, even though it's the least fun paragraph on the page. respect the author, respect the license, periodt 💜

---

and that's a wrap, bestie!! 🎀 this page came to you from perl v5.32.0, dated 2021-01-23, and it's the Net::S...Compat(3pm) page you just read all the way through — proud of you fr fr 💖✨🦋