Skip to content

Commit

Permalink
build based on 80d7a0a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 21, 2024
1 parent 4d5605c commit e15b298
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/faq/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
elseif one_of_field === :option2
do_someting_else(one_of_field[])
# ...
end</code></pre><ul><li><p>When you <em>know</em> that the <code>oneof</code> field is guaranteed to be received when decoding, you can tell the <code>protojl</code> not to use a <code>Union</code> by providing a <code>force_requires</code> keyword argument with <code>Dict(&quot;my_proto_file.proto&quot; =&gt; Set(&quot;MyMessage.one_of_field&quot;))</code>.</p></li><li><p>You can parametrize your structs on the type of <code>oneof</code>s by providing a <code>parametrize_oneofs=true</code> keyword argument to <code>protojl</code>.</p></li></ul><h3 id="How-complete-is-this-package?"><a class="docs-heading-anchor" href="#How-complete-is-this-package?">How complete is this package?</a><a id="How-complete-is-this-package?-1"></a><a class="docs-heading-anchor-permalink" href="#How-complete-is-this-package?" title="Permalink"></a></h3><p>The package should have fairly complete support for both <code>proto2</code> and <code>proto3</code> syntaxes with the following exceptions:</p><ul><li>Services and RPC are not yet supported</li><li>Extensions are not yet supported</li><li>Text Format is not yet supported (but see <a href="#How-do-I-work-with-.textproto-files?">How do I work with <code>.textproto</code> files?</a>)</li></ul><p>Future development will focus on Services and RPC with an overall goal of getting a new, native Julia <code>gRPC</code> implementation.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reference/">« Reference</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 21 February 2024 17:10">Wednesday 21 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><ul><li><p>When you <em>know</em> that the <code>oneof</code> field is guaranteed to be received when decoding, you can tell the <code>protojl</code> not to use a <code>Union</code> by providing a <code>force_requires</code> keyword argument with <code>Dict(&quot;my_proto_file.proto&quot; =&gt; Set(&quot;MyMessage.one_of_field&quot;))</code>.</p></li><li><p>You can parametrize your structs on the type of <code>oneof</code>s by providing a <code>parametrize_oneofs=true</code> keyword argument to <code>protojl</code>.</p></li></ul><h3 id="How-complete-is-this-package?"><a class="docs-heading-anchor" href="#How-complete-is-this-package?">How complete is this package?</a><a id="How-complete-is-this-package?-1"></a><a class="docs-heading-anchor-permalink" href="#How-complete-is-this-package?" title="Permalink"></a></h3><p>The package should have fairly complete support for both <code>proto2</code> and <code>proto3</code> syntaxes with the following exceptions:</p><ul><li>Services and RPC are not yet supported</li><li>Extensions are not yet supported</li><li>Text Format is not yet supported (but see <a href="#How-do-I-work-with-.textproto-files?">How do I work with <code>.textproto</code> files?</a>)</li></ul><p>Future development will focus on Services and RPC with an overall goal of getting a new, native Julia <code>gRPC</code> implementation.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reference/">« Reference</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 21 February 2024 17:15">Wednesday 21 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@
├── foo_bar.jl # defines module `foo_bar`, imports `baz_grok`
└── baz_grok
├── {file_name}_pb.jl
└── baz_grok.jl # defines module `baz_grok`, includes `{file_name}_pb.jl`</code></pre><p>You should include the top-level module of a generated package, i.e. <code>foo_bar.jl</code> in this example. When reading <code>.proto</code> files that use <code>import</code> statements, the imported files have to be located at the respective import paths relative to <code>search_directories</code>.</p><p><code>.proto</code> files that don&#39;t have a <code>package</code> specifier will generate a single file containing a module. For example, <code>{file_name}.proto</code> will translate to a <code>{file_name}_pb.jl</code> file defining a <code>{file_name}_pb</code> module. You can generate a file without a module by providing <code>always_use_modules=false</code> options to <code>protojl</code>.</p><h3 id="Constructors"><a class="docs-heading-anchor" href="#Constructors">Constructors</a><a id="Constructors-1"></a><a class="docs-heading-anchor-permalink" href="#Constructors" title="Permalink"></a></h3><p>By default, there are no additional constructors generated for the Julia structs. You can use the <code>add_kwarg_contructors=true</code> option to <code>protojl</code> to create outer constructors that accept keyword arguments and provide default values where available.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 21 February 2024 17:10">Wednesday 21 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
└── baz_grok.jl # defines module `baz_grok`, includes `{file_name}_pb.jl`</code></pre><p>You should include the top-level module of a generated package, i.e. <code>foo_bar.jl</code> in this example. When reading <code>.proto</code> files that use <code>import</code> statements, the imported files have to be located at the respective import paths relative to <code>search_directories</code>.</p><p><code>.proto</code> files that don&#39;t have a <code>package</code> specifier will generate a single file containing a module. For example, <code>{file_name}.proto</code> will translate to a <code>{file_name}_pb.jl</code> file defining a <code>{file_name}_pb</code> module. You can generate a file without a module by providing <code>always_use_modules=false</code> options to <code>protojl</code>.</p><h3 id="Constructors"><a class="docs-heading-anchor" href="#Constructors">Constructors</a><a id="Constructors-1"></a><a class="docs-heading-anchor-permalink" href="#Constructors" title="Permalink"></a></h3><p>By default, there are no additional constructors generated for the Julia structs. You can use the <code>add_kwarg_contructors=true</code> option to <code>protojl</code> to create outer constructors that accept keyword arguments and provide default values where available.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 21 February 2024 17:15">Wednesday 21 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit e15b298

Please sign in to comment.