Plucen...sReader(3pm)

πŸ“¦
version 1.25 Β· 2 versions
  • 1.25 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 1.25 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– Plucene::Index::TermInfosReader(3pm) πŸ’–

okay so bestie, welcome to the manual page for Plucene::Index::TermInfosReader β€” part of the User Contributed Perl Documentation, and yes she's a Perl module, and yes she's iconic for it. πŸŽ€


✨ NAME ✨

Plucene::Index::TermInfosReader β€” the girl who reads the term infos file. that's it. that's her whole job. πŸ¦‹


🌸 SYNOPSIS 🌸

here's the vibe, copy-paste ready, no cap:

my $reader = Plucene::Index::TermInfosReader->new(
                $dir_name, $segment, $fis);

my Plucene::Index::TermInfo $term_info =
        $reader->get(Plucene::Index::Term $term);

my Plucene::Index::SegmentTermEnum $enum =
        $reader->terms(Plucene::Index::Term $term);

look at her. she's doing so much. πŸ’…


🫢 DESCRIPTION 🫢

so literally, this reads a term infos file. that's the whole description. short, sweet, main character energy. 🌈


πŸ‘‘ METHODS πŸ‘‘

πŸ“ new

my $reader = Plucene::Index::TermInfosReader->new(
                $dir_name, $segment, $fis);

this will create a brand new Plucene::Index::TermInfosReader object for you, using the directory name, the segment name, and the field infos you passed in. three little arguments and boom, she exists. ✨

🧚 get

my Plucene::Index::TermInfo $term_info =
        $reader->get(Plucene::Index::Term $term);

she hands you back a Plucene::Index::TermInfo for the term you gave her. that's the whole method. slay.

πŸ’œ get_int / get_position

these are never called. not once. not ever. they're just sitting there, existing, lowkey decorative. πŸ™ˆ

⭐ terms

my Plucene::Index::SegmentTermEnum $enum =
        $reader->terms(Plucene::Index::Term $term);

this will return the Plucene::Index::SegmentTermEnum for the Plucene::Index::Term you passed in. give her a term, she gives you an enum. the way that works?? obsessed. πŸ’–


fr fr, that's the whole page β€” every option, every method, every code block, untouched. no details were harmed in the making of this rewrite. πŸŽ€

sign-off, periodt: this one's from perl v5.36.0, dated 2022-12-04, and it lives in the User Contributed Perl Documentation. bye bestie, go read some term infos πŸ’…πŸ¦‹βœ¨

πŸ“¦ where this page comes from