You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dev/index.html
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
6
6
julia> struct B end;
7
7
8
-
julia> @sumtype AB(A, B)</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L10-L26">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.variant" href="#LightSumTypes.variant"><code>LightSumTypes.variant</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">variant(inst)</code></pre><p>Returns the variant enclosed in the sum type.</p><p><strong>Example</strong></p><pre><codeclass="language-julia hljs">julia> using LightSumTypes
8
+
julia> @sumtype AB(A, B)</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L10-L26">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.variant" href="#LightSumTypes.variant"><code>LightSumTypes.variant</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">variant(inst)</code></pre><p>Returns the variant enclosed in the sum type.</p><p><strong>Example</strong></p><pre><codeclass="language-julia hljs">julia> using LightSumTypes
9
9
10
10
julia> struct A x::Int end;
11
11
@@ -17,7 +17,7 @@
17
17
AB'.A(0)
18
18
19
19
julia> variant(a)
20
-
A(0)</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L133-L154">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.allvariants" href="#LightSumTypes.allvariants"><code>LightSumTypes.allvariants</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">allvariants(SumType)</code></pre><p>Returns all the enclosed variants types in the sum type in a namedtuple.</p><p><strong>Example</strong></p><pre><codeclass="language-julia hljs">julia> using LightSumTypes
20
+
A(0)</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L133-L154">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.allvariants" href="#LightSumTypes.allvariants"><code>LightSumTypes.allvariants</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">allvariants(SumType)</code></pre><p>Returns all the enclosed variants types in the sum type in a namedtuple.</p><p><strong>Example</strong></p><pre><codeclass="language-julia hljs">julia> using LightSumTypes
21
21
22
22
julia> struct A x::Int end;
23
23
@@ -26,4 +26,4 @@
26
26
julia> @sumtype AB(A, B)
27
27
28
28
julia> allvariants(AB)
29
-
(A = A, B = B)</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L157-L176">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.variantof" href="#LightSumTypes.variantof"><code>LightSumTypes.variantof</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">variantof(inst)</code></pre><p>Returns the type of the variant enclosed in the sum type.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L179-L184">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.is_sumtype" href="#LightSumTypes.is_sumtype"><code>LightSumTypes.is_sumtype</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">is_sumtype(T)</code></pre><p>Returns true if the type is a sum type otherwise returns false.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/7a06e29d65c8756619108926fd9ac0656581558f/src/LightSumTypes.jl#L187-L192">source</a></section></article></article><navclass="docs-footer"><pclass="footer-message">Powered by <ahref="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/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <ahref="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><divclass="modal" id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="auto">Automatic (OS)</option><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option><optionvalue="catppuccin-latte">catppuccin-latte</option><optionvalue="catppuccin-frappe">catppuccin-frappe</option><optionvalue="catppuccin-macchiato">catppuccin-macchiato</option><optionvalue="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <ahref="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/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <spanclass="colophon-date" title="Sunday 24 August 2025 05:44">Sunday 24 August 2025</span>. Using Julia version 1.11.6.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
29
+
(A = A, B = B)</code></pre></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L157-L176">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.variantof" href="#LightSumTypes.variantof"><code>LightSumTypes.variantof</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">variantof(inst)</code></pre><p>Returns the type of the variant enclosed in the sum type.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L179-L184">source</a></section></article><articleclass="docstring"><header><aclass="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><aclass="docstring-binding" id="LightSumTypes.is_sumtype" href="#LightSumTypes.is_sumtype"><code>LightSumTypes.is_sumtype</code></a> — <spanclass="docstring-category">Function</span><spanclass="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><codeclass="language-julia hljs">is_sumtype(T)</code></pre><p>Returns true if the type is a sum type otherwise returns false.</p></div><aclass="docs-sourcelink" target="_blank" href="https://github.com/JuliaDynamics/LightSumTypes.jl/blob/d70d825197d6fc8a2aa1d209faddc39f140132e7/src/LightSumTypes.jl#L187-L192">source</a></section></article></article><navclass="docs-footer"><pclass="footer-message">Powered by <ahref="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/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <ahref="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><divclass="modal" id="documenter-settings"><divclass="modal-background"></div><divclass="modal-card"><headerclass="modal-card-head"><pclass="modal-card-title">Settings</p><buttonclass="delete"></button></header><sectionclass="modal-card-body"><p><labelclass="label">Theme</label><divclass="select"><selectid="documenter-themepicker"><optionvalue="auto">Automatic (OS)</option><optionvalue="documenter-light">documenter-light</option><optionvalue="documenter-dark">documenter-dark</option><optionvalue="catppuccin-latte">catppuccin-latte</option><optionvalue="catppuccin-frappe">catppuccin-frappe</option><optionvalue="catppuccin-macchiato">catppuccin-macchiato</option><optionvalue="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <ahref="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/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <spanclass="colophon-date" title="Wednesday 27 August 2025 17:37">Wednesday 27 August 2025</span>. Using Julia version 1.11.6.</p></section><footerclass="modal-card-foot"></footer></div></div></div></body></html>
0 commit comments