Package com.io7m.coffeepick.runtime.parser.api

# Interface CoffeePickParserType

All Superinterfaces:
  `java.lang.AutoCloseable`, `java.io.Closeable`

    public interface CoffeePickParserType
    extends java.io.Closeable

A parser.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `io.reactivex.rxjava3.core.Observable<ParseError>` | `errors()` |
  `ParserResultType` | `parse()` | Run the parser.
  `java.lang.String` | `provider()` |

  ### Methods inherited from interface java.io.Closeable

  `close`

- ## Method Details

  - ### errors

    io.reactivex.rxjava3.core.Observable<ParseError> errors()
    Returns:
      An observable stream of warnings and errors

  - ### provider

    java.lang.String provider()
    Returns:
      The name of the provider used to construct this parser

  - ### parse

    ParserResultType parse() throws java.io.IOException, ParserFailureException
    Run the parser.
    Returns:
      The result of parsing
    Throws:
      `java.io.IOException` - On I/O errors
      `ParserFailureException` - On fatal parse errors