# textpos

A small library to track human-readable text positions

[![builds.sr.ht status](https://builds.sr.ht/~tobtobxx/textpos.svg)](https://builds.sr.ht/~tobtobxx/textpos?)
[![docs.rs status](https://img.shields.io/docsrs/textpos)](https://docs.rs/textpos/latest/textpos/)


_textpos_ provides simple types that encapsulate a position in a text.
This means that not only the index is tracked, but also the column and line,
ie. the graphical position.


## When to use this library

textpos was created to facilitate writing parsers. It allows a human to inspect
which region of a text maps to which parser.
The library is intended to be used to make this information (which tokens map to
which text reange) human-accesible.


## When not to use this library

The types from this library should not be used to pass text ranges around that
will need to be interpreted by other parts of the program again. Plain and
simple indexes are more precise and easier to use for code working with strings.