TITLE ^

Stream::Base - Stream library base class

VERSION ^

version 0.1

SYNOPSIS ^

This is an abstract baseclass that is not supposed to be used directly.

DESCRIPTION ^

TBD

METHODS ^

assign stream, source

close

stream."dump"() (debug aid)

Dumps the content of the stream.

Returns nothing.

copyTo

source = stream."source"()

Returns the currently set source.

is = stream."connected"()

Returns 1 if the stream is connected, 0 otherwise.

It is connected until the source sub returns.

str = stream."read"()

Returns the read string, or a null string if the stream end has been reached.

stream."include"( stream2 )

Include stream2 in this stream. The next read on this stream will act on the included stream.

Please have a look at examples/streams/Include.imc to see how it works.

stream."flush"() (internal)

Used to flush the stream when including another stream.

stream."read_bytes"( number )

Reads the specified number of bytes from the stream.

stream."byte_buffer"() (internal)

Returns or sets the byte buffer.

AUTHOR ^

Jens Rieks <parrot at jensbeimsurfen dot de> is the author and maintainer. Please send patches and suggestions to the Perl 6 Internals mailing list.

COPYRIGHT ^

Copyright (c) 2004, the Perl Foundation.


parrot