# withIndex()

> Maps all elements of the stream as-is along with their 0-based index.

---

Site [llms.txt](/gatherers4j/llms.txt)

---

### Implementation Notes

Each element of the input stream is mapped to a [`WithIndex`](https://github.com/tginsberg/gatherers4j/blob/main/src/main/java/com/ginsberg/gatherers4j/dto/WithIndex.java) record along with its zero-based index.

**Signature**

`withIndex()`

### Examples

#### Get each element of a stream with its index

```java
Stream
    .of("A", "B", "C")
    .gather(Gatherers4j.withIndex())
    .toList();

// [ WithIndex(0, "A"), WithIndex(1, "B"), WithIndex(2, "C") ]
```