Package com.io7m.coffeepick.runtime.parser.spi

# Interface SPIParserType

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

All Known Implementing Classes:
  `FormatXMLSPIParser`

    @ProviderType
    public interface SPIParserType
    extends java.io.Closeable

A parser.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `io.reactivex.rxjava3.core.Observable<ParseError>` | `errors()` |
  `ParserResultType` | `parse()` | Parse something.

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

  `close`

- ## Method Details

  - ### errors

    io.reactivex.rxjava3.core.Observable<ParseError> errors()
    Returns:
      The sequence of error events produced during parsing

  - ### parse

    ParserResultType parse() throws java.io.IOException, ParserFailureException
    Parse something.
    Returns:
      The parsed value
    Throws:
      `java.io.IOException` - On I/O errors
      `ParserFailureException` - At the end of parsing if any error events have been raised, or if parsing encounters an unrecoverable error