Rex::FS::File(3)

🎀 NAME 🎀

okay bestie, welcome to Rex::FS::File(3) 💖 this is a User Contributed Perl Documentation page, and the manual name is literally Rex::FS::File — it's giving File Class main character energy, no cap.

Rex::FS::File — File Class 🗂️✨

---

🌸 DESCRIPTION 🌸

This is the File Class used by file_write and file_read. periodt 💅

---

🦋 SYNOPSIS 🦋

Here's the whole vibe in code, bestie:

use Rex::Interface::File;
my $fh = Rex::Interface::File->create('Local');
$fh->open( '<', 'filename' );

my $file = Rex::FS::File->new(fh => $fh);
$file->read($len);
$file->read_all;
$file->write($buf);
$file->close;

---

👑 CLASS METHODS 👑

💅 new — the constructor 💅

This is the constructor. You need to set the filehandle which the object should work on or pass a filename.

If you pass a filehandle, it has to be a Rex::Interface::File::* object. iykyk 😌

my $fh = Rex::Interface::File->create('Local');
$fh->open( '<', 'filename' );

my $file = Rex::FS::File->new(fh => $fh);

Create a Rex::FS::File object with a filename — slay:

# open a local file in read mode
my $file = Rex::FS::File->new(
  filename => 'filename',
  mode     => 'r', # or '<'
  type     => 'Local',
);

# or shorter
my $file = Rex::FS::File->new( filename => 'filename' );

# open a local file in write mode
my $file = Rex::FS::File->new(
  filename => 'filename',
  mode     => 'w', # or '>'
);

Allowed modes, no cap:

<  read
r  read
>  write
w  write
>> append
a  append

For allowed "types", see the documentation of Rex::Interface::File. 📚✨

✨ write($buf) ✨

Write $buf into the filehandle. easy peasy:

$file->write("Hello World");

🎀 seek($offset) 🎀

Seek to the file position $offset.

Set the file pointer to the 5th byte. got it? 🫶

$file->seek(5);

🦋 read($len) 🦋

Read $len bytes out of the filehandle. obsessed:

my $content = $file->read(1024);

💜 read_all 💜

Read everything out of the filehandle. the whole thing 💀:

my $content = $file->read_all;

🌈 close 🌈

Close the file. bye bye 👋:

$file->close;

---

mwah 💋 — this iconic page is from perl v5.42.3, dated 2023-08-05. bye bestie 🫶