core/io/streams/lines/lines-docs.factor

   1 USING: help.markup help.syntax io strings ;
   2 IN: io.streams.lines
   3
   4 ARTICLE: "io.streams.lines" "Line reader streams"
   5 "Line reader streams wrap an underlying stream and provide a default implementation of " { $link stream-readln } "."
   6 { $subsection line-reader }
   7 { $subsection <line-reader> } ;
   8
   9 ABOUT: "io.streams.lines"
  10
  11 HELP: line-reader
  12 { $class-description "An input stream which delegates to an underlying stream while providing an implementation of the " { $link stream-readln } " word in terms of the underlying stream's " { $link stream-read-until } ". Line readers are created by calling " { $link <line-reader> } "." } ;
  13
  14 HELP: <line-reader>
  15 { $values { "stream" "an input stream" } { "new-stream" "an input stream" } }
  16 { $description "Creates a new " { $link line-reader } "." }
  17 { $notes "Stream constructors should call this word to wrap streams that do not natively support reading lines. Unix (" { $snippet "\\n" } "), Windows (" { $snippet "\\r\\n" } ") and MacOS (" { $snippet "\\r" } ") line endings are supported." } ;