stream-readln ( stream -- str/f )
Factor handbook » Input and output » Streams » Stream protocol

Prev:	stream-read-partial-into ( buf stream -- buf-slice more? )
Next:	stream-flush ( stream -- )

Vocabulary
io

Inputs

stream

an input stream

Outputs

str/f

a string or f

Generic word contract
Reads a line of input from the stream. Outputs f on stream exhaustion.

Notes
Most code only works on one stream at a time and should instead use readln; see Default input and output streams.

Errors
Throws an error if the I/O operation fails.

Definition

IN: io

GENERIC: stream-readln ( stream -- str/f )

Methods

USING: accessors io io.streams.counting kernel ;

M: counting-stream stream-readln
    [ stream>> ] call \ stream-readln execute ;


USING: curses.listener io io.encodings.string io.encodings.utf8
kernel make ;

M: curses-listener-stream stream-readln
    drop [ curses-stream-readln ] B{ } make utf8 decode ;


USING: io io.encodings io.encodings.private kernel ;

M: decoder stream-readln
    "\r\n" over >decoder< decode-until handle-readln ;


USING: accessors io io.streams.duplex kernel ;

M: duplex-stream stream-readln
    [ in>> ] call \ stream-readln execute ;


USING: io kernel ;

M: f stream-readln drop f ; inline


USING: io kernel ;

M: input-stream stream-readln
    "\n" swap stream-read-until drop ; inline


USING: io sequences ui.tools.listener ;

M: interactor stream-readln interactor-read ?first ;


USING: io io.streams.null kernel ;

M: null-reader stream-readln drop f ;


USING: accessors io kernel readline readline-listener.private
sequences ;

M: readline-reader stream-readln
    flush [ dup [ " " append ] when readline f ] change-prompt
    drop ;


USING: accessors io io.streams.sequence io.streams.string kernel
math sequences ;

M: string-reader stream-readln
    dup >sequence-stream< bounds-check? [
        "\r\n" over sequence-read-until 13 eq? [
            over >sequence-stream< dupd ?nth 10 eq?
            [ 1 + pick i<< ] [ drop ] if
        ] when nip "" or
    ] [ drop f ] if ;


USING: io io.streams.tee io.streams.tee.private kernel ;

M: tee-stream stream-readln
    [ stream-readln ]
    [ [ [ stream-write ] [ stream-nl ] bi ] curry when* ] tee1 ;