Description of "Stream" Data Type

The type "Stream" is defined in /pliant/language/stream/stream.pli module.

Field	Type
read_cur	Address
read_stop	Address
write_cur	Address
write_stop	Address
read_buf	Address
read_buf_size	Int
write_buf	Address
write_buf_size	Int
flags	Int
driver	(Link StreamDriver)
name	Str
list	ListNode_
handle	Int
line_number	Int
line_limit	Int
next_line	Str
rewind_buffers	(List StreamBuffer)
rewind_current	(Pointer StreamBuffer)
rewind_stop	Address
rewind_stack	(Array StreamMark)
rewind_count	Int
rewind_size	Int
rewind_limit	Int


Method name	Arguments							Result

atend	Name	`s`
	Type	Stream						CBool
	Access	`Arw`						`AwvR`

channel_support	Name	`ch`
	Type	Stream						Stream
	Access	`Arw`						`AwmC`

close	Name	`s`
	Type	Stream						ExtendedStatus
	Access	`Arw`						`AwR`

configure	Name	`s`	`command`
	Type	Stream	Str					ExtendedStatus
	Access	`Arw`	`Ar`					`AwR`

eol	Name	`s`
	Type	Stream
	Access	`Arw`

error	Name	`s`	`msg`
	Type	Stream	Str
	Access	`Arw`	`Ar`

file_receive	Name	`stream`	`filename`
	Type	Stream	Str					Status
	Access	`Arw`	`Ar`					`AwvR`

file_receive	Name	`stream`	`filename`	`options`
	Type	Stream	Str	Str				Status
	Access	`Arw`	`Ar`	`Ar`				`AwvR`

file_send	Name	`stream`	`filename`
	Type	Stream	Str					Status
	Access	`Arw`	`Ar`					`AwvR`

file_send	Name	`stream`	`filename`	`options`
	Type	Stream	Str	Str				Status
	Access	`Arw`	`Ar`	`Ar`				`AwvR`

file_tree_receive	Name	`stream`	`path`
	Type	Stream	Str					ExtendedStatus
	Access	`Arw`	`Ar`					`AwR`

file_tree_receive	Name	`stream`	`path`	`options`
	Type	Stream	Str	Str				ExtendedStatus
	Access	`Arw`	`Ar`	`Ar`				`AwR`

file_tree_send	Name	`stream`	`path`
	Type	Stream	Str					Status
	Access	`Arw`	`Ar`					`AwvR`

file_tree_send	Name	`stream`	`path`	`options`
	Type	Stream	Str	Str				Status
	Access	`Arw`	`Ar`	`Ar`				`AwvR`

flush	Name	`s`	`level`
	Type	Stream	Int
	Access	`Arw`	`Arv`

is_crashed	Name	`s`
	Type	Stream						CBool
	Access	`Ar`						`AwvR`

is_open	Name	`s`
	Type	Stream						CBool
	Access	`Ar`						`AwvR`

line_limit (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

line_number (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

name (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Str
	Access	`Ar`						`AwmC`

open	Name	`s`	`name`	`options`	`flags`
	Type	Stream	Str	Str	Int			ExtendedStatus
	Access	`Arw`	`Ar`	`Ar`	`Arv`			`AwR`

open	Name	`s`	`name`	`flags`
	Type	Stream	Str	Int				ExtendedStatus
	Access	`Arw`	`Ar`	`Arv`				`AwR`

open	Name	`s`	`name`	`options`	`flags`	`fs`	`support`
	Type	Stream	Str	Str	Int	FileSystem	Stream	ExtendedStatus
	Access	`Arw`	`Ar`	`Ar`	`Arv`	`OArw`	`Arw`	`AwR`

query	Name	`s`	`command`
	Type	Stream	Str					Str
	Access	`Arw`	`Ar`					`AwR`

raw_read	Name	`s`	`address`	`size`
	Type	Stream	Address	Int
	Access	`Arw`	`Arv`	`Arv`

raw_write	Name	`s`	`address`	`size`
	Type	Stream	Address	Int
	Access	`Arw`	`Arv`	`Arv`

read_available	Name	`s`	`address`	`size`	`maxi`
	Type	Stream	Address	Int	Int
	Access	`Arw`	`Aw`	`Aw`	`Arv`

read_available	Name	`s`	`address`	`size`
	Type	Stream	Address	Int
	Access	`Arw`	`Aw`	`Aw`

readline	Name	`s`
	Type	Stream						Str
	Access	`Arw`						`AwR`

recover	Name	`s`
	Type	Stream
	Access	`Arw`

rewind	Name	`s`
	Type	Stream
	Access	`Arw`

rewind_close	Name	`s`
	Type	Stream
	Access	`Arw`

rewind_limit (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

rewind_open	Name	`s`
	Type	Stream
	Access	`Arw`

safe_configure	Name	`s`	`command`
	Type	Stream	Str					ExtendedStatus
	Access	`Arw`	`Ar`					`AwR`

safe_query	Name	`s`	`command`
	Type	Stream	Str					Str
	Access	`Arw`	`Ar`					`AwR`

stream_driver (alias of . driver) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						(Link StreamDriver)
	Access	`Ar`						`AwmC`

stream_flags (alias of . flags) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

stream_handle (alias of . handle) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

stream_read_buf (alias of . read_buf) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Address
	Access	`Ar`						`AwmC`

stream_read_buf_size (alias of . read_buf_size) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

stream_read_cur (alias of . read_cur) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Address
	Access	`Arv`						`AwmC`

stream_read_stop (alias of . read_stop) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Address
	Access	`Ar`						`AwmC`

stream_write_buf (alias of . write_buf) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Address
	Access	`Ar`						`AwmC`

stream_write_buf_size (alias of . write_buf_size) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Int
	Access	`Ar`						`AwmC`

stream_write_cur (alias of . write_cur) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Address
	Access	`Ar`						`AwmC`

stream_write_stop (alias of . write_stop) (/pliant/language/stream/stream.pli)	Name
	Type	Stream						Address
	Access	`Ar`						`AwmC`

unreadline	Name	`s`	`l`
	Type	Stream	Str
	Access	`Arw`	`Ar`

writechars	Name	`s`	`chars`
	Type	Stream	Str
	Access	`Arw`	`Ar`

writeline	Name	`s`	`l`
	Type	Stream	Str
	Access	`Arw`	`Ar`

(Link Stream) -> Stream (/pliant/language/basic/safe.pli)	implicit
(Pointer Stream) -> Stream (/pliant/language/basic/safe.pli)	implicit

Stream -> Status