Commit 8643fbee8bbde72d6883a84d253b7a4621f0ce94
2017-06-17T13:28:29
README
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
diff --git a/README.md b/README.md
index 6ec3e53..dd55195 100644
--- a/README.md
+++ b/README.md
@@ -1,70 +1,28 @@
-# fd-gray
+# fd-stream
-fd-gray streams are binary gray streams operating on
-`(unsigned-byte 8)` data using `unistd:read`, `unistd:write` and
-`unistd:close` to embed Unix file descriptors in standard Common Lisp
-streams.
+fd-stream streams are `(unsigned-byte 8)` cl-stream streams
+using `unistd:read`, `unistd:write` and `unistd:close` to
+operate on Unix file descriptors.
-### fd-gray:input-stream *fd* --> *stream*
+## Class: fd-stream
-Creates an input stream for file descriptor *fd*.
+### Generic: stream-fd *fd-stream* => *fd*
+Returns the file descriptor of FD-STREAM.
+
+## Class: fd-input-stream
+A buffered input stream using UNISTD:READ.
-```Lisp
-(let ((seq (make-array 128 '(unsigned-byte 8))))
- (read-sequence seq (fd-gray:input-stream 0)))
-```
+### Function: fd-input-stream *fd* => *stream*
+Creates an input stream for file descriptor *fd*.
-### fd-gray:output-stream *fd* --> *stream*
+## Class: fd-output-stream
+A buffered output stream using UNISTD:WRITE.
+### Function: fd-output-stream *fd* => *stream*
Creates an output stream for file descriptor *fd*.
-```Lisp
-(let ((seq (make-array 128 '(unsigned-byte 8))))
- (write-sequence seq (fd-gray:output-stream 1)))
-```
-
-### fd-gray:io-stream *fd* --> *stream*
+## Class: fd-io-stream
+A buffered input/output stream using UNISTD:READ and UNISTD:WRITE.
+### Function: fd-io-stream *fd* => *stream*
Creates an input/output stream for file descriptor *fd*.
-
-```Lisp
-(let ((seq (make-array 128 '(unsigned-byte 8))
- (stream (fd-gray:io-stream (fcntl:open "file.bin" fcntl:+o-rdwr+))))
- (read-sequence seq stream)
- (write-sequence seq stream))
-```
-
-### fd-gray:with-input-stream (*var* *fd*) &body *body* --> *result*
-
-Creates an input stream for file descriptor *fd* that will be closed
-returning from *body*.
-
-```Lisp
-(fd-gray:with-input-stream (in (fcntl:open "file.bin" fcntl:+o-rdonly+))
- (let ((seq (make-array 128 '(unsigned-byte 8))))
- (read-sequence seq in)
- seq))
-```
-
-### fd-gray:with-output-stream (*var* *fd*) &body *body* --> *result*
-
-Creates an output stream for file descriptor *fd* that will be closed
-returning from *body*.
-
-```Lisp
-(let ((seq (make-array 128 '(unsigned-byte 8))))
- (fd-gray:with-output-stream (out (fcntl:open "file.bin" fcntl:+o-wronly+))
- (write-sequence seq out)))
-```
-
-### fd-gray:with-io-stream (*var* *fd*) &body *body* --> *result*
-
-Creates an input/output stream for file descriptor *fd* that will be
-closed returning from *body*.
-
-```Lisp
-(fd-gray:with-io-stream (out (fcntl:open "file.bin" fcntl:+o-rdwr+))
- (let ((seq (make-array 128 '(unsigned-byte 8))))
- (read-sequence seq out)
- (write-sequence seq out)))
-```