From 271013fe9d26cfe6ac29b9b08ae22b9401bcb817 Mon Sep 17 00:00:00 2001 From: Klaus Crusius Date: Wed, 29 Jan 2020 16:30:04 +0100 Subject: [PATCH] changed README.md --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b0e07bf..ca84884 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,23 @@ and corresponding construcors. All access is via the `IO` functions (`read`/`wri `close`, `position`, `bytesavailable`). They may be wrapped in other wrapping streams as well. Some functions may be restricted due to backing the source stream. + + + BoundedInputStream(source::IO, nbytes::Integer; offset=0, close=nbytes) + BoundedOutputStream(source::IO, nbytes::Integer; offset=0, close=nbytes) + +Provide the `IO` interface for reading/writing the source stream `source`. Restrict the +number of bytes to to `nbytes`. + +The optional integer argument `offset` shifts the starting point off the +current position of the source stream. + +The optional argument `close` determines the position of the source stream after +this stream is closed. The special value `BoundedStreams.CLOSE` closes +the source stream in this case. + + + ### Installation ```julia ]add BoundedStreams @@ -41,19 +58,3 @@ as well. Some functions may be restricted due to backing the source stream. y = read(io) ... ``` - - - BoundedInputStream(source::IO, nbytes::Integer; offset=0, close=nbytes) - BoundedOutputStream(source::IO, nbytes::Integer; offset=0, close=nbytes) - -Provide the `IO` interface for reading/writing the source stream `source`. Restrict the -number of bytes to to `nbytes`. - -The optional integer argument `offset` shifts the starting point off the -current position of the source stream. - -The optional argument `close` determines the position of the source stream after -this stream is closed. The special value `BoundedStreams.CLOSE` closes -the source stream in this case. - -