From 0c633a930398ec93d3154e167559ed3df8dad551 Mon Sep 17 00:00:00 2001 From: tgodzik Date: Fri, 20 Dec 2024 13:39:23 +0000 Subject: [PATCH] deploy: 2da1238dd116bd3d33ae461c67b030b6422463af --- docs/contributing.html | 10 +++---- docs/examples.html | 26 +++++++++---------- docs/index.html | 14 +++++----- docs/quickstart.html | 2 +- index.html | 2 +- org/virtuslab/yaml.html | 2 +- org/virtuslab/yaml/AnyOps.html | 2 +- org/virtuslab/yaml/ComposerError.html | 2 +- org/virtuslab/yaml/ConstructError$.html | 2 +- org/virtuslab/yaml/ConstructError.html | 2 +- org/virtuslab/yaml/CoreSchemaTag.html | 2 +- org/virtuslab/yaml/CustomTag.html | 2 +- org/virtuslab/yaml/DecoderMacros$.html | 2 +- org/virtuslab/yaml/LoadSettings$.html | 2 +- org/virtuslab/yaml/LoadSettings.html | 2 +- org/virtuslab/yaml/ModifyError.html | 2 +- org/virtuslab/yaml/Node$$MappingNode$.html | 2 +- org/virtuslab/yaml/Node$$MappingNode.html | 2 +- org/virtuslab/yaml/Node$$ModifyOps.html | 2 +- org/virtuslab/yaml/Node$$ScalarNode$.html | 2 +- org/virtuslab/yaml/Node$$ScalarNode.html | 2 +- org/virtuslab/yaml/Node$$SequenceNode$.html | 2 +- org/virtuslab/yaml/Node$$SequenceNode.html | 2 +- org/virtuslab/yaml/Node$.html | 2 +- org/virtuslab/yaml/Node.html | 2 +- org/virtuslab/yaml/NodeOps.html | 2 +- .../yaml/NodeVisitor$$EitherOps.html | 2 +- org/virtuslab/yaml/NodeVisitor$.html | 2 +- org/virtuslab/yaml/NodeVisitor.html | 2 +- .../yaml/ParseError$$ExpectedTokenKind.html | 2 +- .../ParseError$$NoRegisteredTagDirective.html | 2 +- org/virtuslab/yaml/ParseError$.html | 2 +- org/virtuslab/yaml/ParseError.html | 2 +- org/virtuslab/yaml/Position.html | 2 +- org/virtuslab/yaml/Range.html | 2 +- org/virtuslab/yaml/ScannerError$$AtRange.html | 2 +- .../yaml/ScannerError$$Obtained.html | 2 +- org/virtuslab/yaml/ScannerError$.html | 2 +- org/virtuslab/yaml/ScannerError.html | 2 +- org/virtuslab/yaml/StringOps.html | 2 +- org/virtuslab/yaml/Tag$.html | 2 +- org/virtuslab/yaml/Tag.html | 2 +- org/virtuslab/yaml/YamlCodec$.html | 2 +- org/virtuslab/yaml/YamlCodec.html | 2 +- org/virtuslab/yaml/YamlDecoder$.html | 2 +- org/virtuslab/yaml/YamlDecoder.html | 2 +- org/virtuslab/yaml/YamlEncoder$.html | 2 +- org/virtuslab/yaml/YamlEncoder.html | 2 +- org/virtuslab/yaml/YamlError.html | 2 +- org/virtuslab/yaml/internal.html | 2 +- org/virtuslab/yaml/internal/dump.html | 2 +- org/virtuslab/yaml/internal/dump/present.html | 2 +- .../yaml/internal/dump/present/Presenter.html | 2 +- .../internal/dump/present/PresenterImpl$.html | 2 +- .../yaml/internal/dump/serialize.html | 2 +- .../internal/dump/serialize/Serializer.html | 2 +- .../dump/serialize/SerializerImpl$.html | 2 +- org/virtuslab/yaml/internal/load.html | 2 +- .../yaml/internal/load/TagHandle$$Named.html | 2 +- .../internal/load/TagHandle$$Primary$.html | 2 +- .../internal/load/TagHandle$$Secondary$.html | 2 +- .../yaml/internal/load/TagHandle$.html | 2 +- .../yaml/internal/load/TagHandle.html | 2 +- .../yaml/internal/load/TagPrefix$$Global.html | 2 +- .../yaml/internal/load/TagPrefix$$Local.html | 2 +- .../yaml/internal/load/TagPrefix$.html | 2 +- .../yaml/internal/load/TagPrefix.html | 2 +- .../yaml/internal/load/TagSuffix$.html | 2 +- .../yaml/internal/load/TagSuffix.html | 2 +- .../internal/load/TagValue$$NonSpecific$.html | 2 +- .../internal/load/TagValue$$Shorthand.html | 2 +- .../internal/load/TagValue$$Verbatim.html | 2 +- .../yaml/internal/load/TagValue$.html | 2 +- .../yaml/internal/load/TagValue.html | 2 +- org/virtuslab/yaml/internal/load/compose.html | 2 +- .../yaml/internal/load/compose/Composer.html | 2 +- .../internal/load/compose/ComposerImpl$.html | 2 +- org/virtuslab/yaml/internal/load/parse.html | 2 +- .../yaml/internal/load/parse/Anchor$.html | 2 +- .../yaml/internal/load/parse/Anchor.html | 2 +- .../yaml/internal/load/parse/Event$.html | 2 +- .../yaml/internal/load/parse/Event.html | 2 +- .../internal/load/parse/EventKind$$Alias.html | 2 +- .../load/parse/EventKind$$DocumentEnd.html | 2 +- .../load/parse/EventKind$$DocumentStart.html | 2 +- .../load/parse/EventKind$$MappingEnd$.html | 2 +- .../load/parse/EventKind$$MappingStart.html | 2 +- .../load/parse/EventKind$$Scalar.html | 2 +- .../load/parse/EventKind$$SequenceEnd$.html | 2 +- .../load/parse/EventKind$$SequenceStart.html | 2 +- .../load/parse/EventKind$$StreamEnd$.html | 2 +- .../load/parse/EventKind$$StreamStart$.html | 2 +- .../yaml/internal/load/parse/EventKind$.html | 2 +- .../yaml/internal/load/parse/EventKind.html | 2 +- .../load/parse/NodeEventMetadata$.html | 2 +- .../load/parse/NodeEventMetadata.html | 2 +- .../yaml/internal/load/parse/Parser.html | 2 +- .../yaml/internal/load/parse/ParserImpl$.html | 2 +- .../yaml/internal/load/parse/ParserImpl.html | 2 +- org/virtuslab/yaml/internal/load/reader.html | 2 +- .../yaml/internal/load/reader/Reader$.html | 2 +- .../yaml/internal/load/reader/Reader.html | 2 +- .../yaml/internal/load/reader/Tokenizer$.html | 2 +- .../yaml/internal/load/reader/Tokenizer.html | 2 +- .../internal/load/reader/UrlDecoder$.html | 2 +- .../yaml/internal/load/reader/token.html | 2 +- .../token/BlockChompingIndicator$$Clip$.html | 2 +- .../token/BlockChompingIndicator$$Keep$.html | 2 +- .../token/BlockChompingIndicator$$Strip$.html | 2 +- .../reader/token/BlockChompingIndicator$.html | 2 +- .../reader/token/BlockChompingIndicator.html | 2 +- .../token/ScalarStyle$$DoubleQuoted$.html | 2 +- .../reader/token/ScalarStyle$$Folded$.html | 2 +- .../reader/token/ScalarStyle$$Literal$.html | 2 +- .../reader/token/ScalarStyle$$Plain$.html | 2 +- .../token/ScalarStyle$$SingleQuoted$.html | 2 +- .../load/reader/token/ScalarStyle$.html | 2 +- .../load/reader/token/ScalarStyle.html | 2 +- .../internal/load/reader/token/Token.html | 2 +- .../load/reader/token/TokenKind$$Alias.html | 2 +- .../load/reader/token/TokenKind$$Anchor.html | 2 +- .../reader/token/TokenKind$$BlockEnd$.html | 2 +- .../load/reader/token/TokenKind$$Comma$.html | 2 +- .../reader/token/TokenKind$$DocumentEnd$.html | 2 +- .../token/TokenKind$$DocumentStart$.html | 2 +- .../token/TokenKind$$FlowMappingEnd$.html | 2 +- .../token/TokenKind$$FlowMappingStart$.html | 2 +- .../token/TokenKind$$FlowSequenceEnd$.html | 2 +- .../token/TokenKind$$FlowSequenceStart$.html | 2 +- .../reader/token/TokenKind$$MappingKey$.html | 2 +- .../token/TokenKind$$MappingStart$.html | 2 +- .../token/TokenKind$$MappingValue$.html | 2 +- .../load/reader/token/TokenKind$$Scalar$.html | 2 +- .../load/reader/token/TokenKind$$Scalar.html | 2 +- .../token/TokenKind$$SequenceStart$.html | 2 +- .../token/TokenKind$$SequenceValue$.html | 2 +- .../reader/token/TokenKind$$StreamEnd$.html | 2 +- .../reader/token/TokenKind$$StreamStart$.html | 2 +- .../load/reader/token/TokenKind$$Tag.html | 2 +- .../reader/token/TokenKind$$TagDirective.html | 2 +- .../load/reader/token/TokenKind$.html | 2 +- .../internal/load/reader/token/TokenKind.html | 2 +- org/virtuslab/yaml/syntax.html | 2 +- .../syntax/NodeSelector$$IntSelector.html | 2 +- .../syntax/NodeSelector$$StringSelector.html | 2 +- org/virtuslab/yaml/syntax/NodeSelector$.html | 2 +- org/virtuslab/yaml/syntax/NodeSelector.html | 2 +- org/virtuslab/yaml/syntax/YamlPrimitive$.html | 2 +- org/virtuslab/yaml/syntax/YamlPrimitive.html | 2 +- 149 files changed, 171 insertions(+), 171 deletions(-) diff --git a/docs/contributing.html b/docs/contributing.html index 9b295c6e..b6efc408 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -1,16 +1,16 @@ -Contributing guide
Scala-yaml
0.0.0+1-002a0565-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Contributing guide
-

Run unit tests

+Contributing guide
Scala-yaml
0.0.0+1-2da1238d-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Contributing guide
+

Run unit tests

$ sbt test
-
-

Run integration tests

+
+

Run integration tests

$ sbt IntegrationTest/test
-
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file +
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file diff --git a/docs/examples.html b/docs/examples.html index 38df1efb..e5adcfd7 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -1,5 +1,5 @@ -Examples
Scala-yaml
0.0.0+1-002a0565-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Examples
-

Supported types

+Examples
Scala-yaml
0.0.0+1-2da1238d-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Examples
+

Supported types

Scala-yaml has built-in support for:

  • all primitive types
    • @@ -7,8 +7,8 @@

    Supported types
  • collections from stdlib

-
-

Primitives

+
+

Primitives

import org.virtuslab.yaml.*
 
@@ -21,8 +21,8 @@ 
Primitives
-
-

Option

+
+

Option

When deserializing, YAML differentiates between empty string and null value. Hence in the following yaml

key1: ""
@@ -45,8 +45,8 @@ 
Option
-
-

List

+
+

List

import org.virtuslab.yaml.*
 
@@ -65,8 +65,8 @@ 
List
-
-

Map

+
+

Map

import org.virtuslab.yaml.*
 
@@ -79,8 +79,8 @@ 
Map
-
-

Decoding from unknown type

+
+

Decoding from unknown type

It is also possible to decode yaml of unknown type. Since yaml consists of: scalars, mappings and sequences one can use:

  • as[Any] - it will decode yaml into List or Map depending on its structure
    • @@ -116,4 +116,4 @@

    Deco

-
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file +
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 917c62c1..a5bc21f6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ -Scala-yaml
Scala-yaml
0.0.0+1-002a0565-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml
-

Scala Yaml

+Scala-yaml
Scala-yaml
0.0.0+1-2da1238d-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml
+

Scala Yaml

Example

Scala Yaml is written in Scala, dependency-free library that allows to work with the YAML.

The goal of this project is to create idiomatic library which:

@@ -11,12 +11,12 @@

Scala Yaml

Please see the guide for more information

-
-

Help us create our roadmap!

+
+

Help us create our roadmap!

Take part in our discussions, post your ideas, vote for feature requests and have a real impact on how our next milestone will look like!

-
-

Usage

+
+

Usage

import org.virtuslab.yaml.*
 
@@ -45,4 +45,4 @@ 
Usage
-
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file +
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file diff --git a/docs/quickstart.html b/docs/quickstart.html index 4cdae22a..bb51280c 100644 --- a/docs/quickstart.html +++ b/docs/quickstart.html @@ -1,4 +1,4 @@ -Quick start
Scala-yaml
0.0.0+1-002a0565-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Quick start

Using scala-yaml is very easy, all you have to do is import org.virtuslab.yaml.* and write derives YamlCodec after your case class definition. Then you're able to use following extension methods:

+Quick start
Scala-yaml
0.0.0+1-2da1238d-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Quick start

Using scala-yaml is very easy, all you have to do is import org.virtuslab.yaml.* and write derives YamlCodec after your case class definition. Then you're able to use following extension methods: