DBM::D...::File(3pm)

💖 NAME 💖

okay so this is the manual page for DBM::Deep::Storage::File, living under DBM::D...::File(3pm) in the User Contributed Perl Documentation pile. Its whole job is to mediate low-level interaction with the storage mechanism. That's the name-and-purpose vibe check, bestie. 🎀

---

🧚 PURPOSE 🧚

This is an internal-use-only object for DBM::Deep. It mediates the low-level interaction with the storage mechanism.

Currently, the only storage mechanism supported is the file system. That's it. periodt 💅

---

🦋 OVERVIEW 🦋

This class provides an abstraction to the storage mechanism so that the Engine — and yes, the original really says this is the only class that uses this class — doesn't have to worry about that. Main character energy for the Engine, honestly. ✨

---

🛠️ METHODS 🛠️

🌸 new( \%args ) 🌸

Signature check: new( \%args ). The original page doesn't hand us extra description for this one, so we're not inventing behavior. Ngl, respect. 🫶

🌼 open() 🌼

This method opens the filehandle for the filename in file.

There is no return value. Zero, zilch, nada. 😌

🍓 close() 🍓

If the filehandle is opened, this will close it.

There is no return value.

🎀 size() 🎀

This will return the size of the DB. If file_offset is set, this will take that into account.

NOTE: This function isn't used internally anywhere. Cute little method just chilling. 💀

🦋 set_inode() 🦋

This will set the inode value of the underlying file object.

This is only needed to handle some obscure Win32 bugs. It really shouldn't be needed outside this object.

There is no return value.

✨ print_at( $offset, @data ) ✨

This takes an offset and some data to print.

$offset will be used to seek into the file. If file_offset is set, it will be used as the zero location. If it is undefined, no seeking will occur. Then, @data will be printed to the current location.

There is no return value.

If writing to the file would make the file too big for the pack_size, that is a fatal error. Not a vibe. 🚨

💜 read_at( $offset, $length ) 💜

This takes an optional offset and a length.

$offset, if defined, will be used to seek into the file. If file_offset is set, it will be used as the zero location. If it is undefined, no seeking will occur. Then, $length bytes will be read from the current location.

The data read will be returned. 📖

🫶 DESTROY 🫶

When the ::Storage::File object goes out of scope, it will be closed. Bye bestie, door's right there. 👋

🌈 request_space( $size ) 🌈

This takes a size and adds that much space to the DBM.

This returns the offset for the new location. 🎯

👑 copy_stats( $target_filename ) 👑

This will take the stats for the current filehandle and apply them to $target_filename. The stats copied are:

• Onwer UID and GID — yes, the original spells it that way, and we keep the typo lore around here 😭
• Permissions

---

Mwah 💋✨ — this page is from perl v5.42.0, dated 2023-11-13. Slay.