DlfStream(3pm)

🦋 DlfStream(3pm) 🦋

okay so bestie, this is Lire::DlfStream, straight from LogReport's Lire Documentation — the page is DlfStream(3pm), and it's literally your interface to a DLF data stream ✨. It's giving object-wrapper realness, and we're obsessed 💅.

🌸 NAME 🌸

Lire::DlfStream — interface to DLF data stream 🫶. That's the name, that's the vibe, no cap.

✨ SYNOPSIS ✨

here's the code vibe check, bestie:

use Lire::DlfStore;

my $store = Lire::DlfStore->open( "mystore" );
my $dlf_stream = $store->open_dlf_stream( "www", "r" );

print "Data begins on ", scalar localtime $dlf_stream->start_time(), "\n";
print "Data ends on   ", scalar localtime $dlf_stream->end_time(), "\n";
while ( my $dlf = $dlf_stream->read_dlf() ) {
  ...
}

---

💖 DESCRIPTION 💖

This object encapsulates DLF stream. like, it's the cute little object hug around a DLF stream 🧚, and all the methods below are its main-character moments 👑.

🎀 name

Returns the schema's name of the DlfStream. yes bestie, it's literally telling you the schema name 💖.

💅 mode()

Returns the mode in which the DlfStream was opened. so you can check whether you're in "r" or "w" energy 🔥.

🦋 sort_spec()

Returns the sort specification that is set on the stream. that's the sorting tea, served fresh 🌸.

✨ close()

This method should be called when the Lire::DlfStream isn't needed anymore, otherwise the same DlfStream cannot be opened until then. so yeah, close it when you're done — don't leave your bestie hanging 😭🫶.

🍓 nrecords()

Returns the number of DLF records in the stream. (the manpage literally says “Returs” and honestly, iconic typo, no cap 😭💀.)

🌈 start_time()

Returns the timestamp of the oldest DLF record in the stream in seconds since the epoch. oldest-record timestamp realness, periodt ⭐.

💜 end_time()

Returns the timestamp of the newest DLF record in the stream in seconds since the epoch. newest-record timestamp, slay 💅.

🔥 read_dlf()

Returns an hash reference containing the next DLF record in the stream. It returns undef once the end of the stream is reached.

This method will throw an exception if the DlfStream isn't open in 'r' mode or if there is an error reading the DLF record. so like, read mode only, bestie — respect the vibe check 🚨.

🧚 read_dlf_aref()

Returns the next DLF record in the stream as an array reference. The fields are in the order specified by the schema.

This method will throw an exception if the DlfStream isn't open in 'r' mode or if there is an error reading the DLF record. same read-mode rule, same dramatic exception energy 😤.

👑 write_dlf( $dlf, [ $link_ids ] )

Writes the fields contained in the hash ref $dlf to the DLF stream.

This method will throw an exception if there is an error writing the DLF record or if the stream isn't opened in 'w' mode. write mode only, bestie — no sneaky read-mode writes 🙈.

The $link_ids parameter is used when the stream's schema is a Lire::DerivedSchema. It should be an array reference containing the DLF ids of the records which are linked to this record. so yeah, link ids for the derived-schema girlies 💖.

🎀 clean( [ $time ] )

This method will remove all DLF records older than $time. If $time is omitted, all Dlf records will be removed. like, bye-bye old records — and if you omit $time, it's a full cleanout, so be aware bestie 🧹💀.

---

mwah 💋 — this iconic page comes from Lire 2.1.1, dated 2025-09-28, and that's the footer tea, periodt 🎀✨.