From bcc9ab4ab0394e8630b2c8cd83e6e726bd7135aa Mon Sep 17 00:00:00 2001 From: Docusaurus bot Date: Wed, 13 Nov 2024 15:53:14 +0000 Subject: [PATCH] Deploy website Deploy website version based on 650eaa2540977264c54d9865c8be137401ccf466 --- docs/codecs.html | 22 +++++++++++----------- docs/codecs/index.html | 22 +++++++++++----------- docs/modules.html | 22 +++++++++++----------- docs/modules/index.html | 22 +++++++++++----------- docs/overview.html | 20 ++++++++++---------- docs/overview/index.html | 20 ++++++++++---------- 6 files changed, 64 insertions(+), 64 deletions(-) diff --git a/docs/codecs.html b/docs/codecs.html index 1ea24c80..c19ee213 100644 --- a/docs/codecs.html +++ b/docs/codecs.html @@ -68,12 +68,12 @@ // codec = Validated( // codec = ImapErrors( // codec = Codec("long"), -// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f, -// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106 +// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41, +// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df // ), // validSchema = "long" // ), -// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327 +// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498 // ), // validSchema = {"type":"long","logicalType":"timestamp-millis"} // ), @@ -114,19 +114,19 @@ // codec = Validated( // codec = ImapErrors( // codec = Codec("long"), -// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f, -// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106 +// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41, +// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df // ), // validSchema = "long" // ), -// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327 +// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498 // ), // validSchema = {"type":"long","logicalType":"timestamp-millis"} // ), // typeName = "Instant" // ), -// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@29e3b8c4, -// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@235fa62e +// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@42b2c73c, +// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@6fcde97 // )

When we have a newtype where we ensure values are valid, we can use imapError instead.

@@ -145,7 +145,7 @@ // res5: Codec.Aux[Codec.string.AvroType, SerialNumber] = ImapErrors( // codec = Codec("string"), // f = <function1>, -// g = vulcan.Codec$$Lambda$15907/0x000000010446c040@11c9740e +// g = vulcan.Codec$$Lambda$15880/0x0000000104464840@6c98811d // )

Decimals

@@ -305,8 +305,8 @@

// codec = Validated( // codec = UnionCodec( // alts = Append( -// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@50164c4d), -// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@3db9360f) +// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@f28ca6d), +// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@4dc007a5) // ) // ), // validSchema = ["int","string"] diff --git a/docs/codecs/index.html b/docs/codecs/index.html index 1ea24c80..c19ee213 100644 --- a/docs/codecs/index.html +++ b/docs/codecs/index.html @@ -68,12 +68,12 @@ // codec = Validated( // codec = ImapErrors( // codec = Codec("long"), -// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f, -// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106 +// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41, +// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df // ), // validSchema = "long" // ), -// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327 +// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498 // ), // validSchema = {"type":"long","logicalType":"timestamp-millis"} // ), @@ -114,19 +114,19 @@ // codec = Validated( // codec = ImapErrors( // codec = Codec("long"), -// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f, -// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106 +// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41, +// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df // ), // validSchema = "long" // ), -// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327 +// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498 // ), // validSchema = {"type":"long","logicalType":"timestamp-millis"} // ), // typeName = "Instant" // ), -// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@29e3b8c4, -// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@235fa62e +// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@42b2c73c, +// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@6fcde97 // )

When we have a newtype where we ensure values are valid, we can use imapError instead.

@@ -145,7 +145,7 @@ // res5: Codec.Aux[Codec.string.AvroType, SerialNumber] = ImapErrors( // codec = Codec("string"), // f = <function1>, -// g = vulcan.Codec$$Lambda$15907/0x000000010446c040@11c9740e +// g = vulcan.Codec$$Lambda$15880/0x0000000104464840@6c98811d // )

Decimals

@@ -305,8 +305,8 @@

// codec = Validated( // codec = UnionCodec( // alts = Append( -// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@50164c4d), -// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@3db9360f) +// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@f28ca6d), +// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@4dc007a5) // ) // ), // validSchema = ["int","string"] diff --git a/docs/modules.html b/docs/modules.html index e6aa7e8b..bfe4dd70 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -56,7 +56,7 @@ });

Modules

The following sections describe the additional modules.

Enumeratum

-

The vulcan-docs module provides Codecs for Enumeratum enumerations.

+

The vulcan-enumeratum module provides Codecs for Enumeratum enumerations.

For regular Enums, also mix in VulcanEnum to derive a Codec instance.

import enumeratum.{Enum, EnumEntry, VulcanEnum}
 import enumeratum.EnumEntry.Lowercase
@@ -142,12 +142,12 @@ 
Codec[Day]
 // res3: Codec.Aux[Int, Day] = ImapErrors(
 //   codec = Codec("int"),
-//   f = enumeratum.values.Vulcan$$$Lambda$16307/0x000000010469e040@205f1233,
-//   g = vulcan.Codec$$Lambda$15907/0x000000010446c040@955dbe0
+//   f = enumeratum.values.Vulcan$$$Lambda$16280/0x000000010467d840@591f6bb1,
+//   g = vulcan.Codec$$Lambda$15880/0x0000000104464840@7bf3f548
 // )

Generic

-

The vulcan-docs module provides generic derivation of Codecs using Magnolia for records and unions, and reflection for enumerations and fixed types.

+

The vulcan-generic module provides generic derivation of Codecs using Magnolia for records and unions, and reflection for enumerations and fixed types.

To derive Codecs for case classes or sealed traits, we can use Codec.derive. Annotations like @AvroDoc and @AvroNamespace can be used to customize the documentation and namespace during derivation.

import vulcan.generic._
 
@@ -195,8 +195,8 @@ 
//       codec = Validated(
 //         codec = UnionCodec(
 //           alts = Append(
-//             leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@5c0cfbb3),
-//             rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@42328a5d)
+//             leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@542d2767),
+//             rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@707549b0)
 //           )
 //         ),
 //         validSchema = [{"type":"record","name":"First","namespace":"com.example","fields":[{"name":"value","type":"int"}]},{"type":"record","name":"Second","namespace":"com.example","fields":[{"name":"value","type":"string"}]}]
@@ -216,8 +216,8 @@ 
//   codec = Validated(
 //     codec = UnionCodec(
 //       alts = Append(
-//         leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@216550b7),
-//         rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@6ee4d548)
+//         leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@530026f4),
+//         rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@59c575dc)
 //       )
 //     ),
 //     validSchema = ["int","string"]
@@ -294,7 +294,7 @@ 
// )

Refined

-

The vulcan-docs module provides Codecs for refined refinement types.

+

The vulcan-refined module provides Codecs for refined refinement types.

Refinement types are encoded using their base type (e.g. Int for PosInt). When decoding, Codecs check to ensure values conform to the predicate of the refinement type (e.g. Positive for PosInt), and raise an error for values which do not conform.

import eu.timepit.refined.auto._
 import eu.timepit.refined.types.numeric.PosInt
@@ -303,8 +303,8 @@ 
Codec[PosInt]
 // res9: Codec[eu.timepit.refined.api.Refined[Int, eu.timepit.refined.numeric.Positive]] = ImapErrors(
 //   codec = Codec("int"),
-//   f = vulcan.refined.package$$$Lambda$16329/0x00000001046b7840@7ae177d7,
-//   g = vulcan.Codec$$Lambda$15907/0x000000010446c040@670092c9
+//   f = vulcan.refined.package$$$Lambda$16302/0x0000000104697040@4814bab6,
+//   g = vulcan.Codec$$Lambda$15880/0x0000000104464840@44bb18a7
 // )
 
 Codec.encode[PosInt](1)
diff --git a/docs/modules/index.html b/docs/modules/index.html
index e6aa7e8b..bfe4dd70 100644
--- a/docs/modules/index.html
+++ b/docs/modules/index.html
@@ -56,7 +56,7 @@
             });

Modules

The following sections describe the additional modules.

Enumeratum

-

The vulcan-docs module provides Codecs for Enumeratum enumerations.

+

The vulcan-enumeratum module provides Codecs for Enumeratum enumerations.

For regular Enums, also mix in VulcanEnum to derive a Codec instance.

import enumeratum.{Enum, EnumEntry, VulcanEnum}
 import enumeratum.EnumEntry.Lowercase
@@ -142,12 +142,12 @@ 
Codec[Day]
 // res3: Codec.Aux[Int, Day] = ImapErrors(
 //   codec = Codec("int"),
-//   f = enumeratum.values.Vulcan$$$Lambda$16307/0x000000010469e040@205f1233,
-//   g = vulcan.Codec$$Lambda$15907/0x000000010446c040@955dbe0
+//   f = enumeratum.values.Vulcan$$$Lambda$16280/0x000000010467d840@591f6bb1,
+//   g = vulcan.Codec$$Lambda$15880/0x0000000104464840@7bf3f548
 // )

Generic

-

The vulcan-docs module provides generic derivation of Codecs using Magnolia for records and unions, and reflection for enumerations and fixed types.

+

The vulcan-generic module provides generic derivation of Codecs using Magnolia for records and unions, and reflection for enumerations and fixed types.

To derive Codecs for case classes or sealed traits, we can use Codec.derive. Annotations like @AvroDoc and @AvroNamespace can be used to customize the documentation and namespace during derivation.

import vulcan.generic._
 
@@ -195,8 +195,8 @@ 
//       codec = Validated(
 //         codec = UnionCodec(
 //           alts = Append(
-//             leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@5c0cfbb3),
-//             rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@42328a5d)
+//             leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@542d2767),
+//             rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@707549b0)
 //           )
 //         ),
 //         validSchema = [{"type":"record","name":"First","namespace":"com.example","fields":[{"name":"value","type":"int"}]},{"type":"record","name":"Second","namespace":"com.example","fields":[{"name":"value","type":"string"}]}]
@@ -216,8 +216,8 @@ 
//   codec = Validated(
 //     codec = UnionCodec(
 //       alts = Append(
-//         leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@216550b7),
-//         rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@6ee4d548)
+//         leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@530026f4),
+//         rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@59c575dc)
 //       )
 //     ),
 //     validSchema = ["int","string"]
@@ -294,7 +294,7 @@ 
// )

Refined

-

The vulcan-docs module provides Codecs for refined refinement types.

+

The vulcan-refined module provides Codecs for refined refinement types.

Refinement types are encoded using their base type (e.g. Int for PosInt). When decoding, Codecs check to ensure values conform to the predicate of the refinement type (e.g. Positive for PosInt), and raise an error for values which do not conform.

import eu.timepit.refined.auto._
 import eu.timepit.refined.types.numeric.PosInt
@@ -303,8 +303,8 @@ 
Codec[PosInt]
 // res9: Codec[eu.timepit.refined.api.Refined[Int, eu.timepit.refined.numeric.Positive]] = ImapErrors(
 //   codec = Codec("int"),
-//   f = vulcan.refined.package$$$Lambda$16329/0x00000001046b7840@7ae177d7,
-//   g = vulcan.Codec$$Lambda$15907/0x000000010446c040@670092c9
+//   f = vulcan.refined.package$$$Lambda$16302/0x0000000104697040@4814bab6,
+//   g = vulcan.Codec$$Lambda$15880/0x0000000104464840@44bb18a7
 // )
 
 Codec.encode[PosInt](1)
diff --git a/docs/overview.html b/docs/overview.html
index eed3fad0..d6c80c0a 100644
--- a/docs/overview.html
+++ b/docs/overview.html
@@ -63,9 +63,9 @@
 
Documentation is kept up-to-date, currently documenting v1.11.1 on Scala 2.13.

 
Getting Started

 
To get started with sbt, simply add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan" % "1.11.1"
 

-
Published for Scala 2.13. For changes, refer to the release notes.

+
Published for Scala 2.12, 2.13 and 3.3. For changes, refer to the release notes.

 
For Scala 2.12, enable partial unification by adding the following line to build.sbt.

 
scalacOptions += "-Ypartial-unification"
 

@@ -73,15 +73,15 @@ 
Following are additional provided modules.

 
Enumeratum

 
For enumeratum support, add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan-enumeratum" % "1.11.1"
 

 
Generic

 
For generic derivation support, add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan-generic" % "1.11.1"
 

 
Refined

 
For refined support, add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan-refined" % "1.11.1"
 

 
External Modules

 
Following is an incomplete list of third-party integrations.

@@ -98,7 +98,7 @@ 
resolvers += Resolver.sonatypeRepo("snapshots")
 
-libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1+11-167e9244-SNAPSHOT"
+libraryDependencies += "com.github.fd4s" %% "vulcan" % "1.11.1+12-650eaa25-SNAPSHOT"
 

 
Dependencies

 
Refer to the table below for dependencies and version support across modules.

@@ -107,10 +107,10 @@ 
Apache Avro 1.11.4, Cats 2.12.0Scala 2.13
-vulcan-docsEnumeratum 1.7.5Scala 2.13
-vulcan-docsMagnolia 0.17.0, Shapeless 2.3.12Scala 2.13
-vulcan-docsRefined 0.11.2Scala 2.13
+vulcanApache Avro 1.11.4, Cats 2.12.0Scala 2.12, 2.13 and 3.3
+vulcan-enumeratumEnumeratum 1.7.5Scala 2.12 and 2.13
+vulcan-genericMagnolia 0.17.0, Shapeless 2.3.12Scala 2.12, 2.13 and 3.3
+vulcan-refinedRefined 0.11.2Scala 2.12, 2.13 and 3.3
 
 
 
Inspiration

diff --git a/docs/overview/index.html b/docs/overview/index.html
index eed3fad0..d6c80c0a 100644
--- a/docs/overview/index.html
+++ b/docs/overview/index.html
@@ -63,9 +63,9 @@
 
Documentation is kept up-to-date, currently documenting v1.11.1 on Scala 2.13.

 
Getting Started

 
To get started with sbt, simply add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan" % "1.11.1"
 

-
Published for Scala 2.13. For changes, refer to the release notes.

+
Published for Scala 2.12, 2.13 and 3.3. For changes, refer to the release notes.

 
For Scala 2.12, enable partial unification by adding the following line to build.sbt.

 
scalacOptions += "-Ypartial-unification"
 

@@ -73,15 +73,15 @@ 
Following are additional provided modules.

 
Enumeratum

 
For enumeratum support, add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan-enumeratum" % "1.11.1"
 

 
Generic

 
For generic derivation support, add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan-generic" % "1.11.1"
 

 
Refined

 
For refined support, add the following line to your build.sbt file.

-
libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1"
+
libraryDependencies += "com.github.fd4s" %% "vulcan-refined" % "1.11.1"
 

 
External Modules

 
Following is an incomplete list of third-party integrations.

@@ -98,7 +98,7 @@ 
resolvers += Resolver.sonatypeRepo("snapshots")
 
-libraryDependencies += "com.github.fd4s" %% "vulcan-docs" % "1.11.1+11-167e9244-SNAPSHOT"
+libraryDependencies += "com.github.fd4s" %% "vulcan" % "1.11.1+12-650eaa25-SNAPSHOT"
 

 
Dependencies

 
Refer to the table below for dependencies and version support across modules.

@@ -107,10 +107,10 @@ 
Apache Avro 1.11.4, Cats 2.12.0Scala 2.13
-vulcan-docsEnumeratum 1.7.5Scala 2.13
-vulcan-docsMagnolia 0.17.0, Shapeless 2.3.12Scala 2.13
-vulcan-docsRefined 0.11.2Scala 2.13
+vulcanApache Avro 1.11.4, Cats 2.12.0Scala 2.12, 2.13 and 3.3
+vulcan-enumeratumEnumeratum 1.7.5Scala 2.12 and 2.13
+vulcan-genericMagnolia 0.17.0, Shapeless 2.3.12Scala 2.12, 2.13 and 3.3
+vulcan-refinedRefined 0.11.2Scala 2.12, 2.13 and 3.3
 
 
 
Inspiration