summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2019-07-04 07:14:25 -0700
committerKaz Kylheku <kaz@kylheku.com>2019-07-04 07:14:25 -0700
commit1a80dcbb725b8197369048a3eff4492e9797567f (patch)
treee6b62868a5bf0652e212efe065e69fc85a09c0d8 /txr.1
parentfe9a0303c60fa1ff636ac866f1cc73f380503d5b (diff)
downloadtxr-1a80dcbb725b8197369048a3eff4492e9797567f.tar.gz
txr-1a80dcbb725b8197369048a3eff4492e9797567f.tar.bz2
txr-1a80dcbb725b8197369048a3eff4492e9797567f.zip
Expose make-byte-input-stream.
* stream.c (stream_init): Register make-byte-input-stream intrinsic. * txr.1: Documented.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.131
1 files changed, 31 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 3989c5ca..5bc1622c 100644
--- a/txr.1
+++ b/txr.1
@@ -47306,6 +47306,37 @@ from the string output stream, as if by the
function, and returned as the result value
of the form.
+.coNP Function @ make-byte-input-stream
+.synb
+.mets (make-byte-input-stream << obj )
+.syne
+.desc
+The
+.code make-byte-input-stream
+creates a stream which supports the
+.code get-byte
+operation for traversing a byte-wise representation of
+.metn obj .
+
+The function serves as a generic interface for calling one of
+several other stream constructing functions based on the
+type of the
+.meta obj
+argument.
+
+The
+.meta obj
+argument must be either a buffer, in which case
+.code make-byte-input-stream
+behaves like
+.codn make-buf-stream ,
+or else a string, in which case the function behaves like
+.codn make-string-byte-input-stream .
+
+Note: the repertoire of types handled by
+.code make-byte-input-stream
+may expand in future language versions.
+
.coNP Function @ close-stream
.synb
.mets (close-stream < stream <> [ throw-on-error-p ])