build based on 3062a3e

Author: Documenter.jl

previews/PR1323/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-06-29T17:37:20","julia_version":"1.12.6"}}
+{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-06-29T17:50:26","julia_version":"1.12.6"}}

previews/PR1323/api/client/index.html

@@ -54,4 +54,4 @@
 parse_multipart(message, required_type=nothing) -&gt; Union{Vector{Multipart}, Nothing}</code></pre><p>Parse a multipart payload (either <code>multipart/form-data</code> or <code>multipart/mixed</code>) using the boundary from <code>content_type_header</code>.</p><p>The <code>message</code> overload accepts either a <code>Request</code> or <code>Response</code> and automatically extracts the Content-Type header and body bytes.</p><p>If <code>required_type</code> is specified (e.g., <code>:formdata</code> or <code>:mixed</code>), only that type will be parsed. If <code>required_type</code> is <code>nothing</code>, any multipart type will be parsed.</p><p>Returns <code>nothing</code> when either input is missing, the content type is not a multipart type, or the type doesn&#39;t match <code>required_type</code> if specified.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_forms.jl#L462-L477">source</a></section></details></article><article><details class="docstring" open="true"><summary id="HTTP.parse_multipart_mixed"><a class="docstring-binding" href="#HTTP.parse_multipart_mixed"><code>HTTP.parse_multipart_mixed</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">parse_multipart_mixed(content_type_header, body) -&gt; Union{Vector{Multipart}, Nothing}
 parse_multipart_mixed(message) -&gt; Union{Vector{Multipart}, Nothing}</code></pre><p>Parse a <code>multipart/mixed</code> payload using the boundary from <code>content_type_header</code>.</p><p>The <code>message</code> overload accepts either a <code>Request</code> or <code>Response</code> and automatically extracts the Content-Type header and body bytes.</p><p>Returns <code>nothing</code> when either input is missing or the content type is not <code>multipart/mixed</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_forms.jl#L507-L517">source</a></section></details></article><h2 id="Proxy-Configuration"><a class="docs-heading-anchor" href="#Proxy-Configuration">Proxy Configuration</a><a id="Proxy-Configuration-1"></a><a class="docs-heading-anchor-permalink" href="#Proxy-Configuration" title="Permalink"></a></h2><article><details class="docstring" open="true"><summary id="HTTP.ProxyConfig"><a class="docstring-binding" href="#HTTP.ProxyConfig"><code>HTTP.ProxyConfig</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">ProxyConfig(url; no_proxy=nothing)
 ProxyConfig(; http=nothing, https=nothing, all=nothing, no_proxy=nothing, env=false)</code></pre><p>HTTP client proxy configuration.</p><p>Use this to route plain HTTP, HTTPS, or all traffic through explicit proxy targets, optionally with <code>NoProxy</code> exclusions or environment-driven defaults. Proxy URLs support <code>http://</code>, <code>https://</code> parsing for future compatibility (<code>https://</code> proxy transport is not implemented yet), and SOCKS5 proxy transport with <code>socks5://</code> or <code>socks5h://</code>. As in Go&#39;s <code>net/http</code> transport, <code>socks5://</code> and <code>socks5h://</code> both send domain targets to the SOCKS proxy instead of resolving them locally.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_proxy.jl#L50-L63">source</a></section></details></article><article><details class="docstring" open="true"><summary id="HTTP.ProxyURL"><a class="docstring-binding" href="#HTTP.ProxyURL"><code>HTTP.ProxyURL</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">ProxyURL(url; no_proxy=nothing) -&gt; ProxyConfig</code></pre><p>Convenience constructor for a single proxy URL applied to all outbound requests. Supported proxy URL schemes are <code>http://</code>, <code>https://</code> (parsed but not yet dialed as a TLS proxy), <code>socks5://</code>, and <code>socks5h://</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_proxy.jl#L438-L444">source</a></section></details></article><article><details class="docstring" open="true"><summary id="HTTP.ProxyFromEnvironment"><a class="docstring-binding" href="#HTTP.ProxyFromEnvironment"><code>HTTP.ProxyFromEnvironment</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">ProxyFromEnvironment() -&gt; ProxyConfig</code></pre><p>Load proxy configuration from the standard <code>HTTP_PROXY</code>, <code>HTTPS_PROXY</code>, <code>ALL_PROXY</code>, and <code>NO_PROXY</code> environment variables. Proxy values may use the same schemes accepted by <code>ProxyURL</code>, including <code>socks5://</code> and <code>socks5h://</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_proxy.jl#L449-L455">source</a></section></details></article><article><details class="docstring" open="true"><summary id="HTTP.NoProxy"><a class="docstring-binding" href="#HTTP.NoProxy"><code>HTTP.NoProxy</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">NoProxy(spec)
-NoProxy()</code></pre><p>Matcher for <code>NO_PROXY</code>-style bypass rules.</p><p><code>spec</code> may be a comma-separated string or vector-like collection containing hostnames, domain suffixes, IP literals, CIDR ranges, or <code>host:port</code> entries.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_proxy.jl#L22-L30">source</a></section></details></article><h2 id="HTTP/2-Configuration"><a class="docs-heading-anchor" href="#HTTP/2-Configuration">HTTP/2 Configuration</a><a id="HTTP/2-Configuration-1"></a><a class="docs-heading-anchor-permalink" href="#HTTP/2-Configuration" title="Permalink"></a></h2><article><details class="docstring" open="true"><summary id="HTTP.HTTP2Settings"><a class="docstring-binding" href="#HTTP.HTTP2Settings"><code>HTTP.HTTP2Settings</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">HTTP2Settings(; initial_window_size=65535, connection_window_size=65535)</code></pre><p>HTTP/2 flow-control configuration shared by <a href="../server/#HTTP.Server"><code>Server</code></a>, <a href="../client/#HTTP.Client"><code>Client</code></a>, and <code>connect_h2!</code>.</p><ul><li><code>initial_window_size</code>: the per-stream receive window advertised via <code>SETTINGS_INITIAL_WINDOW_SIZE</code> (RFC 7540 §6.5.2).</li><li><code>connection_window_size</code>: the connection-level receive window. Values above the protocol default of 65535 are applied with an initial <code>WINDOW_UPDATE</code>.</li></ul><p>Both default to the protocol default of 65535, leaving existing behavior unchanged. Raising them improves single-stream throughput on links with non-trivial latency, where the default 64 KiB window would otherwise cap a transfer at roughly <code>window / RTT</code>. The per-stream receive buffer cap is derived from <code>initial_window_size</code>, so it does not need to be configured separately.</p><p><code>initial_window_size</code> may be set below the default to apply tighter per-stream backpressure. <code>connection_window_size</code> must be at least the protocol default of 65535: the connection-level window starts at that value and can only be enlarged with a <code>WINDOW_UPDATE</code>, so a smaller value cannot be advertised.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http2.jl#L32-L53">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reference/">« Overview</a><a class="docs-footer-nextpage" href="../client/">Client »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Monday 29 June 2026 17:37">Monday 29 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+NoProxy()</code></pre><p>Matcher for <code>NO_PROXY</code>-style bypass rules.</p><p><code>spec</code> may be a comma-separated string or vector-like collection containing hostnames, domain suffixes, IP literals, CIDR ranges, or <code>host:port</code> entries.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http_proxy.jl#L22-L30">source</a></section></details></article><h2 id="HTTP/2-Configuration"><a class="docs-heading-anchor" href="#HTTP/2-Configuration">HTTP/2 Configuration</a><a id="HTTP/2-Configuration-1"></a><a class="docs-heading-anchor-permalink" href="#HTTP/2-Configuration" title="Permalink"></a></h2><article><details class="docstring" open="true"><summary id="HTTP.HTTP2Settings"><a class="docstring-binding" href="#HTTP.HTTP2Settings"><code>HTTP.HTTP2Settings</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">HTTP2Settings(; initial_window_size=65535, connection_window_size=65535)</code></pre><p>HTTP/2 flow-control configuration shared by <a href="../server/#HTTP.Server"><code>Server</code></a>, <a href="../client/#HTTP.Client"><code>Client</code></a>, and <code>connect_h2!</code>.</p><ul><li><code>initial_window_size</code>: the per-stream receive window advertised via <code>SETTINGS_INITIAL_WINDOW_SIZE</code> (RFC 7540 §6.5.2).</li><li><code>connection_window_size</code>: the connection-level receive window. Values above the protocol default of 65535 are applied with an initial <code>WINDOW_UPDATE</code>.</li></ul><p>Both default to the protocol default of 65535, leaving existing behavior unchanged. Raising them improves single-stream throughput on links with non-trivial latency, where the default 64 KiB window would otherwise cap a transfer at roughly <code>window / RTT</code>. The per-stream receive buffer cap is derived from <code>initial_window_size</code>, so it does not need to be configured separately.</p><p><code>initial_window_size</code> may be set below the default to apply tighter per-stream backpressure. <code>connection_window_size</code> must be at least the protocol default of 65535: the connection-level window starts at that value and can only be enlarged with a <code>WINDOW_UPDATE</code>, so a smaller value cannot be advertised.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaWeb/HTTP.jl/blob/3062a3eaa4e96f830d9145020a410ad7650989f3/src/http2.jl#L32-L53">source</a></section></details></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reference/">« Overview</a><a class="docs-footer-nextpage" href="../client/">Client »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Monday 29 June 2026 17:50">Monday 29 June 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>