/ 
Iterator-Flex-0.18
River stage zero No dependents
/ Iterator::Flex::Manual::Glossary

NAME

Iterator::Flex::Manual::Glossary - Glossary

VERSION

version 0.18

INTERNALS

NAME

Iterator::Flex::Manual::Glossary

GLOSSARY

iterable object

An iterable object is an object which can be wrapped by an Iterator::Flex::Base based iterator, and which has one or more of the following:

  • __iter__ or iter methods

  • __next__ or next methods

  • an overloaded <> operator

    These should return the next item.

  • an overloaded &{} operator

    This should return a code reference which returns the next item. The coderef will be called as

    $next = $coderef->( $obj )

  • an overloaded @{} operator

    This should return a code reference which returns an array reference. The coderef will be called as

    $next = $coderef->( $obj )

Additionally, if the object has the following methods, they are used to implement the prev and current capabilities.

  • __prev__ or prev

  • __current__ or current

iterable thing

An iterable thing is an entity which can be wrapped by an Iterator::Flex::Base based iterator.

It may be one of the following:

  • an "iterable object"

  • an arrayref

  • a coderef, which must return the next element in the iteration.

  • a globref, assumed to be a filehandle.

SUPPORT

Bugs

Please report any bugs or feature requests to bug-iterator-flex@rt.cpan.org or through the web interface at: https://rt.cpan.org/Public/Dist/Display.html?Name=Iterator-Flex

Source

Source is available at

https://gitlab.com/djerius/iterator-flex

and may be cloned from

https://gitlab.com/djerius/iterator-flex.git

SEE ALSO

Please see those modules/websites for more information related to this module.

AUTHOR

Diab Jerius <djerius@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Smithsonian Astrophysical Observatory.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007