From 38072ffe518dd46aae2a82382764c8a2e090eb1b Mon Sep 17 00:00:00 2001 From: Doug Coleman Date: Mon, 5 Oct 2009 16:16:59 -0500 Subject: [PATCH] clarify behavior of seekable/nonseekable limited streams --- basis/io/streams/limited/limited-docs.factor | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/basis/io/streams/limited/limited-docs.factor b/basis/io/streams/limited/limited-docs.factor index 833e53820e..6c1806ff38 100755 --- a/basis/io/streams/limited/limited-docs.factor +++ b/basis/io/streams/limited/limited-docs.factor @@ -88,7 +88,7 @@ HELP: stream-throws { stream-eofs stream-throws } related-words ARTICLE: "io.streams.limited" "Limited input streams" -"The " { $vocab-link "io.streams.limited" } " vocabulary wraps a stream to behave as if it had only a limited number of bytes, either throwing an error or returning " { $link f } " upon reaching the end." $nl +"The " { $vocab-link "io.streams.limited" } " vocabulary wraps a stream to behave as if it had only a limited number of bytes, either throwing an error or returning " { $link f } " upon reaching the end. Limiting a non-seekable stream keeps a byte count and triggers the end-of-stream behavior when this byte count has been reached. However, limiting a seekable stream creates a window of bytes that supports seeking and re-reading of bytes in that window." $nl "Wrap a stream in a limited stream:" { $subsections limit } "Wrap the current " { $link input-stream } " in a limited stream:"