Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Search::Xapian::ValueIterator

Name Search::Xapian::ValueIterator
Version
Located at /usr/lib64/perl5/vendor_perl
File /usr/lib64/perl5/vendor_perl/Search/Xapian/ValueIterator.pm
Is Core No
Search CPAN for this module Search::Xapian::ValueIterator
Documentation Search::Xapian::ValueIterator
Module Details Search::Xapian::ValueIterator

NAME

Search::Xapian::ValueIterator - Iterate over value slots in a document.


DESCRIPTION

This object represents a stream of document values. It overloads ++ for advancing the iterator, or you can explicitly call the inc method. This class also overloads eq, ne, ==, !=, and "" (stringification).


METHODS

new
Constructor. Defaults to a uninitialized iterator.

clone
inc
Advance the iterator by one. (Called implictly by ++ overloading )

get_valueno
Return the number of the value slot at the current position.

get_value
Return the string in the value slot at current position. Also overloaded as the "" operator.

get_description
Returns a string describing this object.

equal
Checks if a valueiterator is the same as this valueiterator. Also overloaded as the eq and != operators.

nequal
Checks if a valueiterator is different from this valueiterator. Also overloaded as the ne and != operators.


SEE ALSO

the Search::Xapian manpage, the Search::Xapian::Document manpage

Perl Diver brought to you by ScriptSolutions.com © 1997- 2025