MetaCP...::File(3pm)

📦
version 2.044000 · 10 versions
, in ubuntu stonking

💖 MetaCP...::File(3pm) — the File data object, bestie edition 💖

okay so this is MetaCPAN::Client::File, a Perl module from the User Contributed Perl Documentation, and it's literally just a File data object. that's the whole vibe. it's the little wrapper that holds one file's worth of MetaCPAN truth. let's get into it 🫶

✨ VERSION ✨

version 2.044000

🌸 DESCRIPTION 🌸

A MetaCPAN file entity object.

like. it's a file. it's an object. it's an entity. slay 💅

🎀 ATTRIBUTES 🎀

every one of these is a thing you can ask this object about itself. no skips, no cuts, all of them are here:

  • status — gives you the release status, and it's one of "backpan", "cpan", or "latest". vibe check passed ✨
  • date — an ISO8601 datetime string, like "2016-11-19T12:41:46", telling you when the file got uploaded. timestamped, periodt 🕐
  • author — the author's PAUSE id. that's their whole identity on the CPAN streets 🪪
  • maturity — either "release" or "developer". two options, no in-between, pick a lane 🌈
  • directory — a boolean: does this path represent a directory or not? yes/no, iconic behavior 📁
  • indexed — a boolean: is the content indexed or not? 🔍
  • documentation — the name of the module this file contains docs for. heads up though: this one may be undef. not me getting undef'd 😭
  • id — the file's internal MetaCPAN id. the backstage pass 🎟️
  • authorized — a boolean: was this file part of an authorized upload? ✅
  • version — the distribution version that contains this file.
  • version_numified — the numified version of the distribution that contains the file. yes it's numified. no we don't make the rules 🔢
  • release — the release that contains this file, something like "Moose-2.2004". iconic name ngl 🐮
  • binary — a boolean: does this file contain binary content? 🧬
  • name — the File's name, without any directory path included. just the name, bestie ✂️
  • path — the file's path inside the distribution archive, relative to the root of the archive 🗺️
  • abstract — if the file contains POD with a "NAME" section, this attribute holds the abstract portion of that name. cute lil summary energy 📝
  • deprecated — the deprecated field value for this file. it's giving expired, fr fr 💀
  • description — if the file contains POD with a "DESCRIPTION" section, this attribute contains that description 📖
  • distribution — the name of the distribution that contains the file 📦
  • level — a 0-indexed indication of how many directories deep this file is, relative to the archive root. (0-indexed!! programmers stay unhinged 💅)
  • sloc — if the file contains code, this holds the number of lines of code in the file. sloc = source lines of code, iykyk ⌨️
  • slop — if the file contains POD, this holds the number of lines of POD in the file. slop!! yes really, slop 🍲
  • mime — the file's mime type 🎭
  • module — if the file contains module indexed by PAUSE, this attribute holds an arrayref of hashrefs, one for each module. those hashrefs have these keys:
    • name — the module name.
    • indexed — whether or not the file is indexed by MetaCPAN.
    • authorized — whether or not the module is part of an authorized upload.
    • version — the version of the module that this file contains.
    • version_numified — the numified version of the module that this file contains.
    • associated_pod — a path you can use with the "MetaCPAN::Client->file" method to get the file that contains POD for this module. in most cases that's gonna be the same file as the one that contains this "module" data. convenient ✨
  • pod_lines — An arrayref. that's it. that's the description. short king 👑
  • stat — a hashref containing stat() all information about the file 🌸 the keys are:
    • mtime — the Unix epoch of the file's last modified time ⏳
    • mode — the file's mode, as an integer, not an octal representation. read that again, bestie!! 🚨
    • size — the file's size in bytes 📏
  • download_url — a URL for the distribution archive that contains this file. go get it 🔗

🔥 METHODS 🔥

🧚 pod

my $pod = $module->pod(); # default = plain
my $pod = $module->pod($type);

Returns the POD content for the module/file.

Takes a type as argument.

Supported types: plain, html, x-pod, x-markdown. four flavors, all valid, all slay 💅

🦋 source

my $source = $module->source();

Returns the source code for the file. the actual real code, periodt ⌨️💖

👑

metacpan_url

Returns a link to the file source page on MetaCPAN. clickable excellence 🔗✨

💜 AUTHORS 💜

  • Sawyer X <xsawyerx@cpan.org>
  • Mickey Nasriachi <mickey@cpan.org>

the icons who built this. we love them 🫶

This software is copyright (c) 2016 by Sawyer X.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

lowkey the most generous license setup — do what you want, just keep the same terms. bestie behavior fr fr 🍓

and that's the whole page, no notes 💖 this was documented under perl v5.40.1 and stamped 2026-07-05 — shoutout to those exact numbers, and to MetaCP...::File(3pm) for being the moment. mwah, go read some source code, you got this 👑🌸

📦 where this page comes from