ParseResult

sealed interface ParseResult<out T>(source)

Result of parsing an OpenAPI specification file.

Use pattern matching to handle both outcomes:

when (val result = SpecParser.parse(file)) {
is ParseResult.Success -> result.value
is ParseResult.Failure -> handleErrors(result.error)
}

Both Success and Failure may carry warnings about non-fatal issues encountered during parsing or validation.

Inheritors

Types

Link copied to clipboard
data class Failure(val error: Issue.Error, val warnings: List<Issue.Warning>) : ParseResult<Nothing>
Link copied to clipboard
data class Success<out T>(val value: T, val warnings: List<Issue.Warning>) : ParseResult<T>

Properties

Link copied to clipboard
abstract val warnings: List<Issue.Warning>