Difference between revisions of "Lua:Class:Stream"
Jump to navigation
Jump to search
(Replaced content with '<span style="font-size:25px;color:red">Sorry! Content not available.</span>') |
m (Reverted edits by This content is not available (Talk) to last revision by TheyCallMeTim13) |
||
| Line 1: | Line 1: | ||
| − | + | [[Category:Lua]] | |
| + | Stream '''class''': ('''Inheritance''': ''[[Object]]'') | ||
| + | |||
| + | Base class for byte stream objects. | ||
| + | |||
| + | == Properties == | ||
| + | ; Size : integer | ||
| + | : The byte size of the stream. | ||
| + | |||
| + | ; Position : integer | ||
| + | : The current byte position of the stream. | ||
| + | |||
| + | == Methods == | ||
| + | |||
| + | ; copyFrom(''stream'', ''count'') | ||
| + | : Copies 'count' number of bytes from the given 'stream' to this stream | ||
| + | : Note: Always set 'Postion' before using 'copyFrom' (i.e.: 0 for start of steam). | ||
| + | |||
| + | :'''Example''': | ||
| + | local stringStream = createStringStream() | ||
| + | stringStream.Position = 0 -- if not set before using 'copyFrom' the 'StringStream' object will be inconsistent. | ||
| + | stringStream.copyFrom(tableFile.Stream, tableFile.Stream.Size) | ||
| + | |||
| + | ; read(''count'') : table | ||
| + | : Returns a byte table containing the bytes of the stream. | ||
| + | : This increases the position. | ||
| + | |||
| + | ; write(''byteTable'', ''count'' OPTIONAL) | ||
| + | : Writes the given bytetable to the stream | ||
| + | |||
| + | == See also == | ||
| + | * [[Lua]] | ||
| + | * [[Help_File:Script engine|Script engine]] | ||
| + | |||
| + | === Related Functions === | ||
| + | * [[createMemoryStream]] | ||
| + | * [[createFileStream]] | ||
| + | * [[createStringStream]] | ||
| + | |||
| + | === Related Classes === | ||
| + | * [[MemoryStream]] | ||
| + | * [[FileStream]] | ||
| + | * [[StringStream]] | ||
Latest revision as of 19:07, 18 March 2019
Stream class: (Inheritance: Object)
Base class for byte stream objects.
Properties[edit]
- Size : integer
- The byte size of the stream.
- Position : integer
- The current byte position of the stream.
Methods[edit]
- copyFrom(stream, count)
- Copies 'count' number of bytes from the given 'stream' to this stream
- Note: Always set 'Postion' before using 'copyFrom' (i.e.: 0 for start of steam).
- Example:
local stringStream = createStringStream() stringStream.Position = 0 -- if not set before using 'copyFrom' the 'StringStream' object will be inconsistent. stringStream.copyFrom(tableFile.Stream, tableFile.Stream.Size)
- read(count) : table
- Returns a byte table containing the bytes of the stream.
- This increases the position.
- write(byteTable, count OPTIONAL)
- Writes the given bytetable to the stream
