Scala-yaml
0.0.0+1-3a0c8214-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/org.virtuslab.yaml

org.virtuslab.yaml

package org.virtuslab.yaml

Members list

Packages

package org.virtuslab.yaml.internal
package org.virtuslab.yaml.syntax

Type members

Classlikes

final implicit class AnyOps[T](val t: T) extends AnyVal

Attributes

Source
Yaml.scala
Supertypes
class AnyVal
trait Matchable
class Any
final case class ComposerError(msg: String) extends YamlError

Attributes

Source
YamlError.scala
Supertypes
trait Product
trait Equals
class YamlError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
final case class ConstructError(errorMsg: String, node: Option[Node], expected: Option[String]) extends YamlError

Attributes

Companion
object
Source
YamlError.scala
Supertypes
trait Product
trait Equals
class YamlError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ConstructError

Attributes

Companion
class
Source
YamlError.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CoreSchemaTag(value: String) extends Tag

Attributes

Source
Tag.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Tag
class Object
trait Matchable
class Any
Show all
final case class CustomTag(value: String) extends Tag

Attributes

Source
Tag.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Tag
class Object
trait Matchable
class Any
Show all
object DecoderMacros

Attributes

Source
YamlDecoderCrossCompat.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case class LoadSettings(constructors: Map[Tag, YamlDecoder[_]])

Attributes

Companion
object
Source
LoadSettings.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LoadSettings

Attributes

Companion
class
Source
LoadSettings.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ModifyError(msg: String) extends YamlError

Attributes

Source
YamlError.scala
Supertypes
trait Product
trait Equals
class YamlError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait Node

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

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

Attributes

Companion
object
Source
Node.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class MappingNode
class ScalarNode
class SequenceNode
object Node

Attributes

Companion
trait
Source
Node.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Node.type
final implicit class NodeOps(val node: Node) extends AnyVal

Attributes

Source
Yaml.scala
Supertypes
class AnyVal
trait Matchable
class Any
class NodeVisitor(node: Node, selectors: List[NodeSelector])

Attributes

Companion
object
Source
NodeVisitor.scala
Supertypes
class Object
trait Matchable
class Any
object NodeVisitor

Attributes

Companion
class
Source
NodeVisitor.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class ParseError(val msg: String) extends YamlError

Attributes

Companion
object
Source
YamlError.scala
Supertypes
class YamlError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
object ParseError

Attributes

Companion
class
Source
YamlError.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ParseError.type
final case class Position(offset: Int, line: Int, column: Int)

Attributes

Source
Range.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Range(start: Position, input: Vector[String], end: Option[Position])

Attributes

Source
Range.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract class ScannerError(val msg: String) extends YamlError, NoStackTrace

Attributes

Companion
object
Source
YamlError.scala
Supertypes
trait NoStackTrace
class YamlError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class AtRange
class Obtained
object ScannerError

Attributes

Companion
class
Source
YamlError.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final implicit class StringOps(val str: String) extends AnyVal

Attributes

Source
Yaml.scala
Supertypes
class AnyVal
trait Matchable
class Any
sealed trait Tag

Attributes

Companion
object
Source
Tag.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CustomTag
object Tag

Attributes

Companion
trait
Source
Tag.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Tag.type
trait YamlCodec[T] extends YamlDecoder[T], YamlEncoder[T]

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

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

Attributes

Companion
object
Source
YamlCodec.scala
Supertypes
trait YamlEncoder[T]
trait YamlDecoder[T]
class Object
trait Matchable
class Any
Self type
object YamlCodec

Attributes

Companion
trait
Source
YamlCodec.scala
Supertypes
class Object
trait Matchable
class Any
Self type
YamlCodec.type
trait YamlDecoder[T]

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

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

Attributes

Companion
object
Source
YamlDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait YamlCodec[T]
Self type
object YamlDecoder

Attributes

Companion
trait
Source
YamlDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait YamlEncoder[T]

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

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

Attributes

Companion
object
Source
YamlEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait YamlCodec[T]
Self type
object YamlEncoder

Attributes

Companion
trait
Source
YamlEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class YamlError(val msg: String) extends Exception

An ADT representing a decoding failure.

An ADT representing a decoding failure.

Attributes

Source
YamlError.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class ModifyError
class ParseError
class ScannerError
class AtRange
class Obtained
Show all

Value members

Concrete methods

def decodeManyYamls[T](str: String)(implicit c: YamlDecoder[T], settings: LoadSettings): Either[YamlError, List[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.

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.

Attributes

Source
Yaml.scala
def decodeYaml[T](str: String)(implicit c: YamlDecoder[T], settings: LoadSettings): 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.

Attributes

Source
Yaml.scala
inline def deriveYamlCodec[T](using m: Of[T]): YamlCodec[T]

Attributes

Source
derivers.scala
inline def deriveYamlDecoder[T](using m: Of[T]): YamlDecoder[T]

Attributes

Source
derivers.scala
inline def deriveYamlEncoder[T](using m: Of[T]): YamlEncoder[T]

Attributes

Source
derivers.scala
def parseManyYamls(str: String): Either[YamlError, List[Node]]

Parse multiple YAML documents from the given string.

Parse multiple YAML documents from the given string.

Attributes

Source
Yaml.scala
def parseYaml(str: String): Either[YamlError, Node]

Parse YAML from the given string.

Parse YAML from the given string.

Attributes

Source
Yaml.scala

Implicits

Implicits

final implicit def AnyOps[T](t: T): AnyOps[T]

Attributes

Source
Yaml.scala
final implicit def NodeOps(node: Node): NodeOps

Attributes

Source
Yaml.scala
final implicit def StringOps(str: String): StringOps

Attributes

Source
Yaml.scala
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab