stream-length ( stream -- n/f )
Factor handbook » Input and output » Streams » Stream protocol

Prev:

tell-output ( -- n )

Vocabulary
io

Inputs

stream

a stream

Outputs

n/f	an integer or f

Word description
Returns the length of the data supplied by stream, or f if the stream is not seekable or has unknown length.

Notes
Stream seeking is not supported on streams that do not have a known length, e.g. TCP/IP streams.

See also
stream-seek, stream-tell, stream-seekable?

Definition

IN: io

GENERIC: stream-length ( stream -- n/f )

Methods

USING: accessors io tools.image.analyzer.utils ;

M: backwards-reader stream-length stream>> stream-length ;


USING: accessors io io.ports math ;

M: buffered-port stream-length
    handle>> handle-length [ f ] when-zero ;


USING: accessors io io.streams.byte-array sequences ;

M: byte-reader stream-length underlying>> length ; inline


USING: io kernel ;

M: input-stream stream-length drop f ; inline


USING: accessors io io.streams.limited kernel math.order ;

M: limited-stream stream-length
    dup stream>> stream-length
    [ swap limit>> min ] [ drop f ] if* ; inline


USING: io kernel ;

M: output-stream stream-length drop f ; inline


USING: accessors io io.streams.string sequences ;

M: string-reader stream-length underlying>> length ;


USING: accessors io io.streams.throwing ;

M: throws-on-eof-stream stream-length stream>> stream-length ;