NAME

Flux::In - input stream role

VERSION

version 1.00

SYNOPSIS

$line = $in->read;
$chunk = $in->read_chunk($limit);
$in->commit;

DESCRIPTION

Flux::In is the role which every reading stream must implement.

Consumers must implement read, read_chunk and commit methods.

INTERFACE

read()

Get the next item from the stream.

Returns undef when there's no data left.

read_chunk($limit)

Get the new chunk with items. Chunk is an arrayref with items, ordered as if read() was invoked several times.

$limit is a recommendation. Most input streams respect it and return exactly this number of items in chunk, but some don't. So if you get a chunk with 1 item when you asked for 5, don't treat it as a sign that you don't need to read further. Read until you get an undef or an empty chunk.

commit()

Commit input stream's position.

Generally, successful commit means that you can restart your program and continue from the same position next time. Although some streams don't support position at all, for example, array_in from Stream::Simple.

Stream's author should make sure that stream is still readable after this.

AUTHOR

Vyacheslav Matyukhin <me@berekuk.ru>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Yandex LLC.

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