Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history 
Deploy website version based on 650eaa2
  • Loading branch information
Docusaurus bot committed Nov 13, 2024
1 parent e7d23eb commit bcc9ab4
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 64 deletions.
22 changes: 11 additions & 11 deletions docs/codecs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("long"),</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = "long"</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = {"type":"long","logicalType":"timestamp-millis"}</span>
<span class="hljs-comment">// ),</span>
Expand Down Expand Up @@ -114,19 +114,19 @@
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("long"),</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = "long"</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = {"type":"long","logicalType":"timestamp-millis"}</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// typeName = "Instant"</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@29e3b8c4,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@235fa62e</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@42b2c73c,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@6fcde97</span>
<span class="hljs-comment">// )</span>
</code></pre>
<p>When we have a newtype where we ensure values are valid, we can use <code>imapError</code> instead.</p>
Expand All @@ -145,7 +145,7 @@
<span class="hljs-comment">// res5: Codec.Aux[Codec.string.AvroType, SerialNumber] = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("string"),</span>
<span class="hljs-comment">// f = &lt;function1&gt;,</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15907/0x000000010446c040@11c9740e</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15880/0x0000000104464840@6c98811d</span>
<span class="hljs-comment">// )</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="decimals"></a><a href="#decimals" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Decimals</h2>
Expand Down Expand Up @@ -305,8 +305,8 @@ <h2><a class="anchor" aria-hidden="true" id="unions"></a><a href="#unions" aria-
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = UnionCodec(</span>
<span class="hljs-comment">// alts = Append(</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@50164c4d),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@3db9360f)</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@f28ca6d),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@4dc007a5)</span>
<span class="hljs-comment">// )</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = ["int","string"]</span>
Expand Down
22 changes: 11 additions & 11 deletions docs/codecs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("long"),</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = "long"</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = {"type":"long","logicalType":"timestamp-millis"}</span>
<span class="hljs-comment">// ),</span>
Expand Down Expand Up @@ -114,19 +114,19 @@
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("long"),</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@75d9b32f,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@f335106</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@1dc3ca41,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@437846df</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = "long"</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@692c0327</span>
<span class="hljs-comment">// logicalType = org.apache.avro.LogicalTypes$TimestampMillis@4585c498</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = {"type":"long","logicalType":"timestamp-millis"}</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// typeName = "Instant"</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15836/0x00000001043b4840@29e3b8c4,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15837/0x00000001043b4040@235fa62e</span>
<span class="hljs-comment">// f = vulcan.Codec$WithValidSchema$$Lambda$15809/0x000000010441a040@42b2c73c,</span>
<span class="hljs-comment">// g = vulcan.Codec$WithValidSchema$$Lambda$15810/0x000000010441b040@6fcde97</span>
<span class="hljs-comment">// )</span>
</code></pre>
<p>When we have a newtype where we ensure values are valid, we can use <code>imapError</code> instead.</p>
Expand All @@ -145,7 +145,7 @@
<span class="hljs-comment">// res5: Codec.Aux[Codec.string.AvroType, SerialNumber] = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("string"),</span>
<span class="hljs-comment">// f = &lt;function1&gt;,</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15907/0x000000010446c040@11c9740e</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15880/0x0000000104464840@6c98811d</span>
<span class="hljs-comment">// )</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="decimals"></a><a href="#decimals" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Decimals</h2>
Expand Down Expand Up @@ -305,8 +305,8 @@ <h2><a class="anchor" aria-hidden="true" id="unions"></a><a href="#unions" aria-
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = UnionCodec(</span>
<span class="hljs-comment">// alts = Append(</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@50164c4d),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@3db9360f)</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@f28ca6d),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@4dc007a5)</span>
<span class="hljs-comment">// )</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = ["int","string"]</span>
Expand Down
22 changes: 11 additions & 11 deletions docs/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Modules</h1></header><article><div><span><p>The following sections describe the additional modules.</p>
<h2><a class="anchor" aria-hidden="true" id="enumeratum"></a><a href="#enumeratum" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enumeratum</h2>
<p>The <code>vulcan-docs</code> module provides <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s for <a href="https://github.com/lloydmeta/enumeratum">Enumeratum</a> enumerations.</p>
<p>The <code>vulcan-enumeratum</code> module provides <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s for <a href="https://github.com/lloydmeta/enumeratum">Enumeratum</a> enumerations.</p>
<p>For regular <code>Enum</code>s, also mix in <code>VulcanEnum</code> to derive a <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a> instance.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> enumeratum.{<span class="hljs-type">Enum</span>, <span class="hljs-type">EnumEntry</span>, <span class="hljs-type">VulcanEnum</span>}
<span class="hljs-keyword">import</span> enumeratum.<span class="hljs-type">EnumEntry</span>.<span class="hljs-type">Lowercase</span>
Expand Down Expand Up @@ -142,12 +142,12 @@ <h2><a class="anchor" aria-hidden="true" id="enumeratum"></a><a href="#enumeratu
<span class="hljs-type">Codec</span>[<span class="hljs-type">Day</span>]
<span class="hljs-comment">// res3: Codec.Aux[Int, Day] = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("int"),</span>
<span class="hljs-comment">// f = enumeratum.values.Vulcan$$$Lambda$16307/0x000000010469e040@205f1233,</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15907/0x000000010446c040@955dbe0</span>
<span class="hljs-comment">// f = enumeratum.values.Vulcan$$$Lambda$16280/0x000000010467d840@591f6bb1,</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15880/0x0000000104464840@7bf3f548</span>
<span class="hljs-comment">// )</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="generic"></a><a href="#generic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Generic</h2>
<p>The <code>vulcan-docs</code> module provides generic derivation of <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s using <a href="https://github.com/softwaremill/magnolia">Magnolia</a> for records and unions, and reflection for enumerations and fixed types.</p>
<p>The <code>vulcan-generic</code> module provides generic derivation of <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s using <a href="https://github.com/softwaremill/magnolia">Magnolia</a> for records and unions, and reflection for enumerations and fixed types.</p>
<p>To derive <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s for <code>case class</code>es or <code>sealed trait</code>s, we can use <code>Codec.derive</code>. Annotations like <code>@AvroDoc</code> and <code>@AvroNamespace</code> can be used to customize the documentation and namespace during derivation.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> vulcan.generic._

Expand Down Expand Up @@ -195,8 +195,8 @@ <h2><a class="anchor" aria-hidden="true" id="generic"></a><a href="#generic" ari
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = UnionCodec(</span>
<span class="hljs-comment">// alts = Append(</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@5c0cfbb3),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@42328a5d)</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@542d2767),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@707549b0)</span>
<span class="hljs-comment">// )</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// 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"}]}]</span>
Expand All @@ -216,8 +216,8 @@ <h2><a class="anchor" aria-hidden="true" id="generic"></a><a href="#generic" ari
<span class="hljs-comment">// codec = Validated(</span>
<span class="hljs-comment">// codec = UnionCodec(</span>
<span class="hljs-comment">// alts = Append(</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@216550b7),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@6ee4d548)</span>
<span class="hljs-comment">// leftNE = Singleton(a = vulcan.Codec$Alt$$anon$6@530026f4),</span>
<span class="hljs-comment">// rightNE = Singleton(a = vulcan.Codec$Alt$$anon$6@59c575dc)</span>
<span class="hljs-comment">// )</span>
<span class="hljs-comment">// ),</span>
<span class="hljs-comment">// validSchema = ["int","string"]</span>
Expand Down Expand Up @@ -294,7 +294,7 @@ <h2><a class="anchor" aria-hidden="true" id="generic"></a><a href="#generic" ari
<span class="hljs-comment">// )</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="refined"></a><a href="#refined" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Refined</h2>
<p>The <code>vulcan-docs</code> module provides <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s for <a href="https://github.com/fthomas/refined">refined</a> refinement types.</p>
<p>The <code>vulcan-refined</code> module provides <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s for <a href="https://github.com/fthomas/refined">refined</a> refinement types.</p>
<p>Refinement types are encoded using their base type (e.g. <code>Int</code> for <code>PosInt</code>). When decoding, <a href="/vulcan/api/vulcan/Codec.html"><code>Codec</code></a>s check to ensure values conform to the predicate of the refinement type (e.g. <code>Positive</code> for <code>PosInt</code>), and raise an error for values which do not conform.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> eu.timepit.refined.auto._
<span class="hljs-keyword">import</span> eu.timepit.refined.types.numeric.<span class="hljs-type">PosInt</span>
Expand All @@ -303,8 +303,8 @@ <h2><a class="anchor" aria-hidden="true" id="refined"></a><a href="#refined" ari
<span class="hljs-type">Codec</span>[<span class="hljs-type">PosInt</span>]
<span class="hljs-comment">// res9: Codec[eu.timepit.refined.api.Refined[Int, eu.timepit.refined.numeric.Positive]] = ImapErrors(</span>
<span class="hljs-comment">// codec = Codec("int"),</span>
<span class="hljs-comment">// f = vulcan.refined.package$$$Lambda$16329/0x00000001046b7840@7ae177d7,</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15907/0x000000010446c040@670092c9</span>
<span class="hljs-comment">// f = vulcan.refined.package$$$Lambda$16302/0x0000000104697040@4814bab6,</span>
<span class="hljs-comment">// g = vulcan.Codec$$Lambda$15880/0x0000000104464840@44bb18a7</span>
<span class="hljs-comment">// )</span>

<span class="hljs-type">Codec</span>.encode[<span class="hljs-type">PosInt</span>](<span class="hljs-number">1</span>)
Expand Down
Loading

0 comments on commit bcc9ab4

Please sign in to comment.