Author: ruoso Date: 2009-03-13 14:04:50 +0100 (Fri, 13 Mar 2009) New Revision: 25817
Modified: docs/Perl6/Spec/S07-iterators.pod Log: [spec] Add Iterator::PushBack to S07 Modified: docs/Perl6/Spec/S07-iterators.pod =================================================================== --- docs/Perl6/Spec/S07-iterators.pod 2009-03-13 12:08:30 UTC (rev 25816) +++ docs/Perl6/Spec/S07-iterators.pod 2009-03-13 13:04:50 UTC (rev 25817) @@ -148,6 +148,21 @@ When it runs out of items, it will throw an OutOfItemsException. +=head1 The Iterator::PushBack Role + +This role defines an iterator that knows how to receive values back to +be consumed again as if they were never consumed. The iterator is free +to refuse values that were not consumed first and in the correct +order, since this role is not intened to modify the original data, +only to modify the traversal of that data. + +=head2 method pushback($value) {} + +This pushes $value back to the array. If this iterator is proxying +immutable data, it is free to refuse a value that is either out of the +original order or if it wasn't consumed. In that case, it should fail +with UnorderedPushBackException or BadPushBackException. + =head1 Auxiliary Implementations Perl's built-ins require that a number of auxiliary types.