Text.YAML.Types

Reexports

Definitions

0 Anchor : Type

  Name given in a node's `&anchor` property or referenced
  by an `*alias` node.

Totality: total
Visibility: public export

data Style : Type

  The presentation style of a scalar node.

Totality: total
Visibility: public export
Constructors:

Plain : Style

  An unquoted scalar

SingleQ : Style

  A 'single quoted' scalar

DoubleQ : Style

  A "double quoted" scalar

Literal : Style

  A literal (`|`) block scalar

Folded : Style

  A folded (`>`) block scalar

Hints:

Eq Style

Show Style

data Tag : Type

  A node's tag property.

Totality: total
Visibility: public export
Constructors:

NoTag : Tag

  No tag property was given.

NonSpec : Tag

  The `!` non-specific tag.

Verbatim : String -> Tag

  A resolved tag: shorthands have been expanded via the active
  `%TAG` handles, verbatim tags (`!<...>`) are taken as given.

Hints:

Eq Tag

Show Tag

data Event : Type

  A YAML parse event.
  
  A well-formed event stream follows this grammar:
  
  ```
  stream   ::= StreamStart document* StreamEnd
  document ::= DocStart node DocEnd
  node     ::= Alias | Scalar
             | SeqStart node* SeqEnd
             | MapStart (node node)* MapEnd
  ```

Totality: total
Visibility: public export
Constructors:

StreamStart : Event

StreamEnd : Event

DocStart : Bool -> Event

DocEnd : Bool -> Event

SeqStart : Bool -> Maybe Anchor -> Tag -> Event

SeqEnd : Event

MapStart : Bool -> Maybe Anchor -> Tag -> Event

MapEnd : Event

Scalar : Maybe Anchor -> Tag -> Style -> String -> Event

Alias : Anchor -> Event

Hints:

Eq Event

Show Event

printEvent : Event -> String

  Prints an event in the format used by the YAML test suite's
  `test.event` files: https://github.com/yaml/yaml-test-suite

Totality: total
Visibility: export

record Props : Type

  The properties of a node: at most one anchor and one tag
  [spec: c-ns-properties].

Totality: total
Visibility: public export
Constructor: 

MkProps : Maybe Anchor -> Tag -> Props

Projections:

.anchor : Props -> Maybe Anchor

.tag : Props -> Tag

.anchor : Props -> Maybe Anchor

Totality: total
Visibility: public export

anchor : Props -> Maybe Anchor

Totality: total
Visibility: public export

.tag : Props -> Tag

Totality: total
Visibility: public export

tag : Props -> Tag

Totality: total
Visibility: public export

noProps : Props

Totality: total
Visibility: public export

isNoProps : Props -> Bool

Totality: total
Visibility: public export

record TagEnv : Type

  The tag handles declared by `%TAG` directives; `!` and `!!` have
  built-in defaults.

Totality: total
Visibility: public export
Constructor: 

TE : List (String, String) -> TagEnv

Projection: 

.handles : TagEnv -> List (String, String)

.handles : TagEnv -> List (String, String)

Totality: total
Visibility: public export

handles : TagEnv -> List (String, String)

Totality: total
Visibility: public export

defaultEnv : TagEnv

Totality: total
Visibility: public export

data YErr : Type

  YAML-specific parse errors, used as the custom part of
  `InnerError` (see `Text.ParseError`).

Totality: total
Visibility: public export
Constructors:

TabIndent : YErr

BadIndent : YErr

MultipleAnchors : YErr

MultipleTags : YErr

UnknownHandle : String -> YErr

DuplicateHandle : String -> YErr

BadVersion : String -> YErr

BadDirective : String -> YErr

TrailingContent : YErr

InvalidKey : YErr

UndefinedAlias : Anchor -> YErr

  An alias referencing an anchor that is not in scope.

CyclicAlias : Anchor -> YErr

  An alias referencing an anchor whose node is still being
  composed, as in `&a [*a]`: such cyclic structures cannot be
  represented as finite trees.

DuplicateKey : String -> YErr

  A mapping with two equal keys [spec 3.2.1.3]. Carries the
  rendered key.

UnexpectedEvent : String -> YErr

  The composer met a malformed event sequence. Event streams
  produced by `parseEvents` never trigger this. Carries the
  rendered event.

UnexpectedEnd : YErr

  The events ended in the middle of a node or document.

Hints:

Eq YErr

Interpolation YErr

Show YErr

resolveTag : TagEnv -> String -> String -> Either YErr Tag

  Resolves a tag shorthand against the active handles
  [spec: c-ns-shorthand-tag].

Totality: total
Visibility: export

mergeProps : Props -> Props -> Either YErr Props

  Combines properties given on a preceding line with those attached
  directly to a node: at most one anchor and one tag in total.

Totality: total
Visibility: export