package yaml

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. yaml
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package internal
  2. package syntax

Type Members

  1. implicit final class AnyOps[T] extends AnyVal
  2. final case class ComposerError(msg: String) extends YamlError with Product with Serializable
  3. final case class ConstructError(errorMsg: String, node: Option[Node], expected: Option[String]) extends YamlError with Product with Serializable
  4. final case class CoreSchemaTag(value: String) extends Tag with Product with Serializable
  5. final case class CustomTag(value: String) extends Tag with Product with Serializable
  6. case class LoadSettings(constructors: Map[Tag, YamlDecoder[_]]) extends Product with Serializable
  7. final case class ModifyError(msg: String) extends YamlError with Product with Serializable
  8. sealed trait Node extends AnyRef

    ADT that corresponds to the YAML representation graph nodes https://yaml.org/spec/1.2/spec.html#id2764044

  9. implicit final class NodeOps extends AnyVal
  10. class NodeVisitor extends AnyRef
  11. sealed abstract class ParseError extends YamlError
  12. final case class Position(offset: Int, line: Int, column: Int) extends Product with Serializable
  13. final case class Range(start: Position, input: Vector[String], end: Option[Position] = None) extends Product with Serializable
  14. sealed abstract class ScannerError extends YamlError with NoStackTrace
  15. implicit final class StringOps extends AnyVal
  16. sealed trait Tag extends AnyRef
  17. trait YamlCodec[T] extends YamlDecoder[T] with YamlEncoder[T]

    A type class that provides both-way conversion between Node and T

  18. trait YamlDecoder[T] extends AnyRef

    A type class that provides a conversion from a Node into given type T

  19. trait YamlEncoder[T] extends AnyRef

    A type class that provides a conversion from a given type T into Node

  20. sealed abstract class YamlError extends Exception

    An ADT representing a decoding failure.

Value Members

  1. def decodeManyYamls[T](str: String)(implicit c: YamlDecoder[T], settings: LoadSettings = LoadSettings.empty): Either[YamlError, List[T]]

    Decode all YAML documents from the given String, returning either YamlError or a list of T.

    Decode all YAML documents from the given String, returning either YamlError or a list of T. The error will be the first failure in parsing or converting to T.

  2. def decodeYaml[T](str: String)(implicit c: YamlDecoder[T], settings: LoadSettings = LoadSettings.empty): Either[YamlError, T]

    Parse a YAML document from the given String, returning either YamlError or T.

    Parse a YAML document from the given String, returning either YamlError or T.

    According to the specification: - Parser takes input string and produces sequence of events - then Composer produces a representation graph from events - finally YamlDecoder (construct phase from the YAML spec) constructs data type T from the YAML representation.

  3. def parseManyYamls(str: String): Either[YamlError, List[Node]]

    Parse multiple YAML documents from the given string.

  4. def parseYaml(str: String): Either[YamlError, Node]

    Parse YAML from the given string.

  5. object ConstructError extends Serializable
  6. object LoadSettings extends Serializable
  7. object Node
  8. object NodeVisitor
  9. object ParseError extends Serializable
  10. object ScannerError extends Serializable
  11. object Tag
  12. object YamlCodec extends YamlCodecCompanionCrossCompat
  13. object YamlDecoder extends YamlDecoderCompanionCrossCompat
  14. object YamlEncoder extends YamlEncoderCrossCompanionCompat

Inherited from AnyRef

Inherited from Any

Ungrouped