# ruminant, a parser combinator library

**Deprecated**
See my latest stab at this: [`parser-compose`](https://crates.io/crates/parser-compose)

> ⚠️ Warning ☣️  
Homemade, hand-rolled code ahead. Experimental. May not function as advertised.

This is an introduction by example. For a first-principles introduction to
parser combinators see
[here](https://theorangeduck.com/page/you-could-have-invented-parser-combinators).

- A _parser_ is a function that takes some input in, extracts some information and
returns the result of this extraction. In order to make any progress, the
result contains the leftover input after consuming some part of it, or in the
case of error returns some value indicating failure.

- A _combinator_ takes one or more parsers as input and returns a different
parser. They are useful for uhh...combining multiple parsers together or even
changing what parsers do.

With only these two ideas the world becomes your oyster.

_Examples coming sooon_