One advantage of having direct access to the data from the API (i.e. not forcing users to use the filesystem) is that it's easier to write tests.

Also, in my experience writing tests for your module generally gives you a good indication about the quality of the API: if your tests look straight-forward, the API is probably good. update: or rather, if your tests look clumsy, the API is probably bad.

For your specific instance, I would probably write a test like so (method and class-names made up): 

# using Test::More...

my $input_string = "some input data";
my $proc = Data::Processor->new( string => $input_string );

my @out_filenames = $proc->names;

is_deeply(\@out_filenames,[qw(some list of filenames)]);

is($proc->data($some_filename),"data for filename");

$proc->close();

[download]
then you can expand to direct to disk methods: 
my $proc = Data::Processor->( file => "some filename");
# or                          handle => \*DATA

for my $name ($proc->names) {
  $proc->write( $some_filename, file => $name      );
# or                            handle => \*STDOUT
}

[download]

I wouldn't return a hashref with all the filenames and data in it - chances are, that users who want to access the data directly aren't interested in all files, plus, if your archive is big, it would consume a lot of memory.

"What should it profit a man, if he should win a flame war, yet lose his cool?"

In reply to Re: Should Modules Do I/O? by Joost
in thread Should Modules Do I/O? by pboin

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.