|
62 | 62 | ;;; On success, `$size` indicates the number of bytes read, and
|
63 | 63 | ;;; `$read_status` indicates the state of the stream.
|
64 | 64 | ;;;
|
65 |
| - ;;; When `$read_status` is `$read`, `$size` is equal to the total buffer size |
| 65 | + ;;; When `$read_status` is `$ready`, `$size` is equal to the total buffer size |
66 | 66 | ;;; of `$iovs`.
|
67 | 67 | ;;;
|
68 | 68 | ;;; When `$read_status` is `$end`, or on failure, subsequent calls to `read`
|
|
81 | 81 | ;;; On success, `$size` indicates the number of bytes read, and
|
82 | 82 | ;;; `$read_status` indicates the state of the stream.
|
83 | 83 | ;;;
|
84 |
| - ;;; When `$read_status` is `$read`, `$size` is equal to the total buffer size |
| 84 | + ;;; When `$read_status` is `$ready`, `$size` is equal to the total buffer size |
85 | 85 | ;;; of `$iovs`.
|
86 | 86 | ;;;
|
87 | 87 | ;;; When `$read_status` is `$end`, or on failure, subsequent calls to `read`
|
|
199 | 199 | (result $name $pseudonym)
|
200 | 200 | )
|
201 | 201 |
|
202 |
| - ;;; Write a pseudonym's nameto the output stream. |
| 202 | + ;;; Write a pseudonym's name to the output stream. |
203 | 203 | ;;;
|
204 | 204 | ;;; This function traps if the pseudonym is not one obtained from calling
|
205 | 205 | ;;; `input_pseudonym` or `output_pseudonym` with a `$where` parameter of
|
|
209 | 209 | ;;; which display the name in contexts where the name is already
|
210 | 210 | ;;; exposed.
|
211 | 211 | (@interface func (export "write_pseudonym")
|
| 212 | + ;;; The output to write to. |
212 | 213 | (param $source $output_byte_stream)
|
| 214 | + ;;; The pseudonym representing the name to write. |
213 | 215 | (param $name $pseudonym)
|
| 216 | + ;;; Indicate success or failure. |
214 | 217 | (result $result (expected (error)))
|
215 | 218 | )
|
216 | 219 |
|
|
227 | 230 | (result $result (expected $size (error)))
|
228 | 231 | )
|
229 | 232 |
|
230 |
| - ;;; Forward up to `$n` bytes from an input stream to an output stream. |
| 233 | + ;;; Forward up to `$len` bytes from an input stream to an output stream. |
231 | 234 | ;;;
|
232 | 235 | ;;; If a failure occurs on the output stream, the remaining data from the
|
233 | 236 | ;;; input stream is consumed and discarded.
|
|
245 | 248 | ;;; Return an input stream and an output stream where the input is
|
246 | 249 | ;;; transmitted to the output.
|
247 | 250 | (@interface func (export "pipe")
|
| 251 | + ;;; A stream for reading from the created pipe. |
248 | 252 | (result $source $input_byte_stream)
|
| 253 | + ;;; A stream for writing to the created pipe. |
249 | 254 | (result $sink $output_byte_stream)
|
250 | 255 | )
|
251 | 256 |
|
252 | 257 | ;;; Return an output stream which discards data sent to it.
|
253 | 258 | (@interface func (export "null")
|
| 259 | + ;;; A stream for writing bytes to be discarded. |
254 | 260 | (result $sink $output_byte_stream)
|
255 | 261 | )
|
256 | 262 | )
|
0 commit comments