Interface IBytesRefEnumerator

A simple enumerator interface for BytesRef iteration.

Namespace: Lucene.Net.Util

Assembly: Lucene.Net.dll

Syntax

public interface IBytesRefEnumerator

Properties

Comparer

Return the BytesRef Comparer used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.

Declaration

IComparer<BytesRef> Comparer { get; }

Property Value

Type	Description
IComparer<BytesRef>

Current

Gets the BytesRef for the current iteration. The returned BytesRef may be reused across calls to MoveNext().

Declaration

BytesRef Current { get; }

Property Value

Type	Description
BytesRef

Methods

MoveNext()

Increments the iteration to the next BytesRef in the enumerator.

Declaration

bool MoveNext()

Returns

Type	Description
bool	true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

Type	Condition
IOException	If there is a low-level I/O error.