Skip to content

Commit

Permalink
generate proxy.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pat Hickey committed Oct 16, 2023
1 parent 64619d3 commit 42b0665
Showing 1 changed file with 78 additions and 78 deletions.
156 changes: 78 additions & 78 deletions proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,14 @@ reached.</p>
<h4><a name="datetime"><code>type datetime</code></a></h4>
<p><a href="#datetime"><a href="#datetime"><code>datetime</code></a></a></p>
<p>
#### <a name="timezone_display">`record timezone-display`</a>
#### <a name="timezone">`type timezone`</a>
`u32`
<p>A timezone.
<p>In timezones that recognize daylight saving time, also known as daylight
time and summer time, the information returned from the functions varies
over time to reflect these adjustments.</p>
<p>This <a href="https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources">represents a resource</a>.</p>
<h4><a name="timezone_display"><code>record timezone-display</code></a></h4>
<p>Information useful for displaying the timezone of a specific <a href="#datetime"><code>datetime</code></a>.</p>
<p>This information may vary within a single <a href="#timezone"><code>timezone</code></a> to reflect daylight
saving time adjustments.</p>
Expand Down Expand Up @@ -198,13 +205,6 @@ representation of the UTC offset may be returned, such as <code>-04:00</code>.</
should return false.</p>
</li>
</ul>
<h4><a name="timezone"><code>type timezone</code></a></h4>
<p><code>u32</code></p>
<p>A timezone.
<p>In timezones that recognize daylight saving time, also known as daylight
time and summer time, the information returned from the functions varies
over time to reflect these adjustments.</p>
<p>This <a href="https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources">represents a resource</a>.</p>
<hr />
<h3>Functions</h3>
<h4><a name="display"><code>display: func</code></a></h4>
Expand Down Expand Up @@ -284,7 +284,11 @@ when it does, they are expected to subsume this API.</p>
<h4><a name="pollable"><code>type pollable</code></a></h4>
<p><a href="#pollable"><a href="#pollable"><code>pollable</code></a></a></p>
<p>
#### <a name="stream_status">`enum stream-status`</a>
#### <a name="stream_error">`record stream-error`</a>
<p>An error type returned from a stream operation. Currently this
doesn't provide any additional information.</p>
<h5>Record Fields</h5>
<h4><a name="stream_status"><code>enum stream-status</code></a></h4>
<p>Streams provide a sequence of data and then end; once they end, they
no longer provide any further data.</p>
<p>For example, a stream reading from a file ends when the stream reaches
Expand All @@ -301,25 +305,6 @@ socket ends when the socket is closed.</p>
<p>The stream has ended and will not produce any further data.
</li>
</ul>
<h4><a name="stream_error"><code>record stream-error</code></a></h4>
<p>An error type returned from a stream operation. Currently this
doesn't provide any additional information.</p>
<h5>Record Fields</h5>
<h4><a name="output_stream"><code>type output-stream</code></a></h4>
<p><code>u32</code></p>
<p>An output bytestream. In the future, this will be replaced by handle
types.
<p>This conceptually represents a <code>stream&lt;u8, _&gt;</code>. It's temporary
scaffolding until component-model's async features are ready.</p>
<p><a href="#output_stream"><code>output-stream</code></a>s are <em>non-blocking</em> to the extent practical on
underlying platforms. Except where specified otherwise, I/O operations also
always return promptly, after the number of bytes that can be written
promptly, which could even be zero. To wait for the stream to be ready to
accept data, the <a href="#subscribe_to_output_stream"><code>subscribe-to-output-stream</code></a> function to obtain a
<a href="#pollable"><code>pollable</code></a> which can be polled for using <code>wasi_poll</code>.</p>
<p>And at present, it is a <code>u32</code> instead of being an actual handle, until
the wit-bindgen implementation of handles and resources is ready.</p>
<p>This <a href="https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources">represents a resource</a>.</p>
<h4><a name="input_stream"><code>type input-stream</code></a></h4>
<p><code>u32</code></p>
<p>An input bytestream. In the future, this will be replaced by handle
Expand All @@ -335,6 +320,21 @@ can be polled for using <code>wasi_poll</code>.</p>
<p>And at present, it is a <code>u32</code> instead of being an actual handle, until
the wit-bindgen implementation of handles and resources is ready.</p>
<p>This <a href="https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources">represents a resource</a>.</p>
<h4><a name="output_stream"><code>type output-stream</code></a></h4>
<p><code>u32</code></p>
<p>An output bytestream. In the future, this will be replaced by handle
types.
<p>This conceptually represents a <code>stream&lt;u8, _&gt;</code>. It's temporary
scaffolding until component-model's async features are ready.</p>
<p><a href="#output_stream"><code>output-stream</code></a>s are <em>non-blocking</em> to the extent practical on
underlying platforms. Except where specified otherwise, I/O operations also
always return promptly, after the number of bytes that can be written
promptly, which could even be zero. To wait for the stream to be ready to
accept data, the <a href="#subscribe_to_output_stream"><code>subscribe-to-output-stream</code></a> function to obtain a
<a href="#pollable"><code>pollable</code></a> which can be polled for using <code>wasi_poll</code>.</p>
<p>And at present, it is a <code>u32</code> instead of being an actual handle, until
the wit-bindgen implementation of handles and resources is ready.</p>
<p>This <a href="https://github.com/WebAssembly/WASI/blob/main/docs/WitInWasi.md#Resources">represents a resource</a>.</p>
<hr />
<h3>Functions</h3>
<h4><a name="read"><code>read: func</code></a></h4>
Expand Down Expand Up @@ -594,35 +594,6 @@ be used.</p>
#### <a name="pollable">`type pollable`</a>
[`pollable`](#pollable)
<p>
#### <a name="status_code">`type status-code`</a>
`u16`
<p>
#### <a name="scheme">`variant scheme`</a>
<h5>Variant Cases</h5>
<ul>
<li><a name="scheme.http"><code>HTTP</code></a></li>
<li><a name="scheme.https"><code>HTTPS</code></a></li>
<li><a name="scheme.other"><code>other</code></a>: <code>string</code></li>
</ul>
<h4><a name="response_outparam"><code>type response-outparam</code></a></h4>
<p><code>u32</code></p>
<p>
#### <a name="request_options">`record request-options`</a>
<h5>Record Fields</h5>
<ul>
<li><a name="request_options.connect_timeout_ms"><code>connect-timeout-ms</code></a>: option&lt;<code>u32</code>&gt;</li>
<li><a name="request_options.first_byte_timeout_ms"><code>first-byte-timeout-ms</code></a>: option&lt;<code>u32</code>&gt;</li>
<li><a name="request_options.between_bytes_timeout_ms"><code>between-bytes-timeout-ms</code></a>: option&lt;<code>u32</code>&gt;</li>
</ul>
<h4><a name="outgoing_stream"><code>type outgoing-stream</code></a></h4>
<p><a href="#output_stream"><a href="#output_stream"><code>output-stream</code></a></a></p>
<p>
#### <a name="outgoing_response">`type outgoing-response`</a>
`u32`
<p>
#### <a name="outgoing_request">`type outgoing-request`</a>
`u32`
<p>
#### <a name="method">`variant method`</a>
<h5>Variant Cases</h5>
<ul>
Expand All @@ -637,42 +608,71 @@ be used.</p>
<li><a name="method.patch"><code>patch</code></a></li>
<li><a name="method.other"><code>other</code></a>: <code>string</code></li>
</ul>
<h4><a name="incoming_stream"><code>type incoming-stream</code></a></h4>
<p><a href="#input_stream"><a href="#input_stream"><code>input-stream</code></a></a></p>
<h4><a name="scheme"><code>variant scheme</code></a></h4>
<h5>Variant Cases</h5>
<ul>
<li><a name="scheme.http"><code>HTTP</code></a></li>
<li><a name="scheme.https"><code>HTTPS</code></a></li>
<li><a name="scheme.other"><code>other</code></a>: <code>string</code></li>
</ul>
<h4><a name="error"><code>variant error</code></a></h4>
<h5>Variant Cases</h5>
<ul>
<li><a name="error.invalid_url"><code>invalid-url</code></a>: <code>string</code></li>
<li><a name="error.timeout_error"><code>timeout-error</code></a>: <code>string</code></li>
<li><a name="error.protocol_error"><code>protocol-error</code></a>: <code>string</code></li>
<li><a name="error.unexpected_error"><code>unexpected-error</code></a>: <code>string</code></li>
</ul>
<h4><a name="fields"><code>type fields</code></a></h4>
<p><code>u32</code></p>
<p>
#### <a name="incoming_response">`type incoming-response`</a>
`u32`
#### <a name="headers">`type headers`</a>
[`fields`](#fields)
<p>
#### <a name="incoming_request">`type incoming-request`</a>
#### <a name="trailers">`type trailers`</a>
[`fields`](#fields)
<p>
#### <a name="incoming_stream">`type incoming-stream`</a>
[`input-stream`](#input_stream)
<p>
#### <a name="outgoing_stream">`type outgoing-stream`</a>
[`output-stream`](#output_stream)
<p>
#### <a name="future_trailers">`type future-trailers`</a>
`u32`
<p>
#### <a name="future_write_trailers_result">`type future-write-trailers-result`</a>
`u32`
<p>
#### <a name="future_trailers">`type future-trailers`</a>
#### <a name="incoming_request">`type incoming-request`</a>
`u32`
<p>
#### <a name="future_incoming_response">`type future-incoming-response`</a>
#### <a name="outgoing_request">`type outgoing-request`</a>
`u32`
<p>
#### <a name="fields">`type fields`</a>
#### <a name="request_options">`record request-options`</a>
<h5>Record Fields</h5>
<ul>
<li><a name="request_options.connect_timeout_ms"><code>connect-timeout-ms</code></a>: option&lt;<code>u32</code>&gt;</li>
<li><a name="request_options.first_byte_timeout_ms"><code>first-byte-timeout-ms</code></a>: option&lt;<code>u32</code>&gt;</li>
<li><a name="request_options.between_bytes_timeout_ms"><code>between-bytes-timeout-ms</code></a>: option&lt;<code>u32</code>&gt;</li>
</ul>
<h4><a name="response_outparam"><code>type response-outparam</code></a></h4>
<p><code>u32</code></p>
<p>
#### <a name="status_code">`type status-code`</a>
`u16`
<p>
#### <a name="incoming_response">`type incoming-response`</a>
`u32`
<p>
#### <a name="trailers">`type trailers`</a>
[`fields`](#fields)
#### <a name="outgoing_response">`type outgoing-response`</a>
`u32`
<p>
#### <a name="headers">`type headers`</a>
[`fields`](#fields)
#### <a name="future_incoming_response">`type future-incoming-response`</a>
`u32`
<p>
#### <a name="error">`variant error`</a>
<h5>Variant Cases</h5>
<ul>
<li><a name="error.invalid_url"><code>invalid-url</code></a>: <code>string</code></li>
<li><a name="error.timeout_error"><code>timeout-error</code></a>: <code>string</code></li>
<li><a name="error.protocol_error"><code>protocol-error</code></a>: <code>string</code></li>
<li><a name="error.unexpected_error"><code>unexpected-error</code></a>: <code>string</code></li>
</ul>
<hr />
----
<h3>Functions</h3>
<h4><a name="drop_fields"><code>drop-fields: func</code></a></h4>
<h5>Params</h5>
Expand Down

0 comments on commit 42b0665

Please sign in to comment.