zio.blocks.schema.yaml

package zio.blocks.schema.yaml

Members list

Type members

Classlikes

case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

Source
BuildInfo.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
BuildInfo.type
object Yaml

Companion object for Yaml providing factory methods and case class definitions.

Companion object for Yaml providing factory methods and case class definitions.

Attributes

Companion
trait
Source
Yaml.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Yaml.type
sealed trait Yaml

A sealed trait representing a YAML node.

A sealed trait representing a YAML node.

The Yaml type provides a complete representation of YAML data with four possible cases: Yaml.Mapping, Yaml.Sequence, Yaml.Scalar, and Yaml.NullValue.

Attributes

Companion
object
Source
Yaml.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Mapping
object NullValue
class Scalar
class Sequence
abstract class YamlCodec[A] extends BinaryCodec[A]

Abstract base class for YAML binary codecs that serialize/deserialize values of type A to and from YAML representations.

Abstract base class for YAML binary codecs that serialize/deserialize values of type A to and from YAML representations.

Type parameters

A

the type this codec handles

Attributes

Companion
object
Source
YamlCodec.scala
Supertypes
class BinaryCodec[A]
class Object
trait Matchable
class Any
object YamlCodec

Companion object providing primitive YamlCodec instances and type constants.

Companion object providing primitive YamlCodec instances and type constants.

Attributes

Companion
class
Source
YamlCodec.scala
Supertypes
class Object
trait Matchable
class Any
Self type
YamlCodec.type
object YamlCodecDeriver extends YamlCodecDeriver

Default instance of YamlCodecDeriver.

Default instance of YamlCodecDeriver.

Attributes

Companion
class
Source
YamlCodecDeriver.scala
Supertypes
class Object
trait Matchable
class Any
Self type
class YamlCodecDeriver extends Deriver[YamlCodec]

A zio.blocks.schema.derive.Deriver that produces YamlCodec instances for schema-described types, converting between Scala values and YAML representations.

A zio.blocks.schema.derive.Deriver that produces YamlCodec instances for schema-described types, converting between Scala values and YAML representations.

Attributes

Companion
object
Source
YamlCodecDeriver.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class YamlCodecError(var spans: List[Node], message: String) extends Throwable

A custom exception class without the stack trace representing errors that occur during YAML encoding/decoding operations.

A custom exception class without the stack trace representing errors that occur during YAML encoding/decoding operations.

The XmlCodecError class extends Throwable to provide enhanced error reporting for scenarios involving YAML encoding or decoding errors where dynamic data paths (spans) are involved. These spans represent the stack of nodes traversed within the data structure when the error occurred. So that top-level spans are at the end of the list.

Value parameters

message

A descriptive message providing additional context or details about the error.

spans

A list of DynamicOptic.Node objects representing the traversal path within the data structure where the error occurred. Each node encapsulates information about a specific element (field, index, etc.).

Attributes

Source
YamlCodecError.scala
Supertypes
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object YamlFormat extends BinaryFormat[YamlCodec]

A zio.blocks.schema.codec.BinaryFormat for application/yaml using YamlCodecDeriver.

A zio.blocks.schema.codec.BinaryFormat for application/yaml using YamlCodecDeriver.

Attributes

Source
YamlCodecDeriver.scala
Supertypes
trait Format
class Object
trait Matchable
class Any
Self type
YamlFormat.type
object YamlJsonInterop

Attributes

Source
YamlJsonInterop.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object YamlOptions

Attributes

Companion
class
Source
YamlOptions.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class YamlOptions(indentStep: Int = ..., flowStyle: Boolean = ..., documentMarkers: Boolean = ...)

Configuration for YamlWriter output formatting.

Configuration for YamlWriter output formatting.

Value parameters

documentMarkers

when true, prepend --- document start marker

flowStyle

when true, emit collections in inline flow style

indentStep

number of spaces per indentation level (default: 2)

Attributes

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

Parser for YAML 1.2 input, converting YAML text into a Yaml AST.

Parser for YAML 1.2 input, converting YAML text into a Yaml AST.

Attributes

Source
YamlReader.scala
Supertypes
class Object
trait Matchable
class Any
Self type
YamlReader.type
object YamlSyntax

Attributes

Source
YamlSyntax.scala
Supertypes
class Object
trait Matchable
class Any
Self type
YamlSyntax.type
sealed trait YamlTag

Represents a YAML tag that annotates node types (e.g. !!str, !!int).

Represents a YAML tag that annotates node types (e.g. !!str, !!int).

Attributes

Companion
object
Source
YamlTag.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Bool
class Custom
object Float
object Int
object Map
object Null
object Seq
object Str
object Timestamp
Show all
object YamlTag

Predefined YAML core schema tags and a Custom variant for user-defined tags.

Predefined YAML core schema tags and a Custom variant for user-defined tags.

Attributes

Companion
trait
Source
YamlTag.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
YamlTag.type
object YamlWriter

Serializer for the Yaml AST, producing YAML 1.2 text output. Formatting behavior (indentation, flow style, document markers) is controlled via YamlOptions.

Serializer for the Yaml AST, producing YAML 1.2 text output. Formatting behavior (indentation, flow style, document markers) is controlled via YamlOptions.

Attributes

Source
YamlWriter.scala
Supertypes
class Object
trait Matchable
class Any
Self type
YamlWriter.type

Extensions

Extensions

extension (inline sc: StringContext)
inline def yaml(inline args: Any*): Yaml

Attributes

Source
package.scala