---
name: "Search::Xapian::ValueIterator"
section: "3pm"
platform: "linux"
package: "libsearch-xapian-perl"
version: "1.2.25.5-3+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Search::Xapian::ValueIterator"
---

# Search::Xapian::ValueIterator(3pm)

Iterate over value slots in a document.

## 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 \<valueiterator\>

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

- nequal \<valueiterator\>

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

## SEE ALSO

Search::Xapian, Search::Xapian::Document