stream-read-partial-into ( buf stream -- buf-slice more? )
Factor handbook » Input and output » Streams » Stream protocol

Prev:	stream-read-partial ( n stream -- seq/f )
Next:	stream-readln ( stream -- str/f )

Vocabulary
io

Inputs

buf	a byte-array, a specialized-array, or a string
stream	an input stream

Outputs

buf-slice	a slice
more?	a boolean

Generic word contract
Reads available data from the stream into the sequence buf without blocking until all immediately available data is read or the length of buf is reached. If no data is immediately available, blocks until data is available. Returns a slice over the part of buf that was written to, and a boolean that will be f if the stream was exhausted.

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

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

Definition

USING: io.private kernel.private math ;

IN: io

: stream-read-partial-into ( buf stream -- buf-slice more? )
    [ stream-read-partial-unsafe { fixnum } declare ]
    (read-into) ; inline