yamleam/error

Error type for yamleam.

YamlError distinguishes three failure modes:

ParseError — the source is not valid YAML (or not valid in the subset we support); includes a free-form message and the 1-indexed line/column of the offending character
Unsupported — the source uses a YAML feature yamleam does not yet implement; the feature field describes what was encountered and the version it’s targeted for
DecodeError — the source parsed correctly but a decoder rejected the resulting shape

Types

YamlError

pub type YamlError {
  ParseError(message: String, line: Int, column: Int)
  Unsupported(feature: String, line: Int, column: Int)
  DecodeError(errors: List(decode.DecodeError))
}

Constructors

ParseError(message: String, line: Int, column: Int)

Unsupported(feature: String, line: Int, column: Int)

DecodeError(errors: List(decode.DecodeError))

Values

to_string

</>

pub fn to_string(err: YamlError) -> String

Format an error as a single human-readable line for logging or display. Intentionally simple — consumers wanting structured output should pattern-match on the variants themselves.