Stream
Overview
Base stream implementation. Streams can be used to seek, read and write from a foreign resource.
Location
-
Reference:
- Elements.dll .NET, .NET Core 6.0, .NET Standard 2.0
- elements.jar Cooper
- Elements.fx Island, ToffeeV2
- libElements.fx Toffee
- Namespace: RemObjects.Elements.RTL
- Platforms: .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, Toffee, ToffeeV2
CanRead virtual
Implementations should return true if this stream can be read from.
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
Boolean CanRead { __get; }
ReadOnly Property CanRead() As Boolean
CanSeek virtual
Implementations should return true if this stream can be seeked, the position can be changed.
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
Boolean CanSeek { __get; }
ReadOnly Property CanSeek() As Boolean
CanWrite virtual
Implementations should return true if this stream can be written to.
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
Boolean CanWrite { __get; }
ReadOnly Property CanWrite() As Boolean
close Cooper
method close
void close()
func close()
void close()
Sub close()
Close virtual abstract Toffee
func Close(Close )
Parameters:
- :
CopyTo virtual
Copy the content of this stream to another
method CopyTo(Destination: Stream)
void CopyTo(Stream Destination)
func CopyTo(_ Destination: Stream)
void CopyTo(Stream Destination)
Sub CopyTo(Destination As Stream)
Parameters:
- Destination:
Dispose .NET, .NET Core 6.0, .NET Standard 2.0, Island
Close the stream and underlying resources.
method Dispose
void Dispose()
func Dispose()
Sub Dispose()
Flush virtual abstract .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2
Flush the data. Used with file streams to ensure the data is stored on disk
method Flush
void Flush()
func Flush()
void Flush()
Sub Flush()
Flush Flush() virtual abstract Toffee
func Flush(Flush )
Parameters:
- :
GetLength virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
Returns the length of this stream.
GetLength GetLength(): Int64 virtual Toffee
func GetLength(GetLength ) -> Int64
Parameters:
- :
GetPosition virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
Returns the current position in this stream.
method GetPosition: Int64
Int64 GetPosition()
func GetPosition() -> Int64
Function GetPosition() As Int64
GetPosition GetPosition(): Int64 virtual Toffee
func GetPosition(GetPosition ) -> Int64
Parameters:
- :
Length virtual
Returns the length of this stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
Int64 Length { __get; }
ReadOnly Property Length() As Int64
Position virtual
Returns the current position in this stream.
property Position: Int64 read write;
Int64 Position { get; set; }
var Position: Int64 { get{} set{} }
Int64 Position { __get; __set; }
Property Position() As Int64
Read from this stream. Returns the nr of bytes retreived., or 0 when the end has been reached.
Parameters:
- Buffer:
- Count:
Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.
Parameters:
- Buffer:
- Offset:
- Count:
ReadByte virtual .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2
Reads a byte or returns -1 if the stream has reached the end
method ReadByte: Int32
Int32 ReadByte()
func ReadByte() -> Int32
Integer ReadByte()
Function ReadByte() As Int32
Parameters:
- aResult:
ReadByte ReadByte(): Int32 virtual Toffee
func ReadByte(ReadByte ) -> Int32
Parameters:
- :
ReadGuid .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt16BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt16LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt32BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt32LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt64BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt64LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
Seek virtual abstract
this method can be used to change the position of the stream, relative to the current position, start or end of the stream. Returns the new position.
method Seek(Offset: Int64; Origin: SeekOrigin): Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64
Parameters:
- Offset:
- Origin:
SetPosition virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island
Sets the absolute position in the stream.
method SetPosition(Value: Int64)
void SetPosition(Int64 Value)
func SetPosition(_ Value: Int64)
Sub SetPosition(Value As Int64)
Parameters:
- Value:
Parameters:
- Buffer:
Writes data to the stream.
Parameters:
- Buffer:
- Count:
Writes data to the stream.
Parameters:
- Buffer:
- Offset:
- Count:
WriteByte virtual
Writes data to the stream.
method WriteByte(aValue: Byte)
void WriteByte(Byte aValue)
func WriteByte(_ aValue: Byte)
void WriteByte(Byte aValue)
Sub WriteByte(aValue As Byte)
Parameters:
- aValue:
WriteGuid .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt16BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt16LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt32BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt32LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt64BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt64LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
CanRead virtual
Implementations should return true if this stream can be read from.
property CanRead: Boolean read;
Boolean CanRead { get; }
var CanRead: Boolean { get{} }
Boolean CanRead { __get; }
ReadOnly Property CanRead() As Boolean
CanSeek virtual
Implementations should return true if this stream can be seeked, the position can be changed.
property CanSeek: Boolean read;
Boolean CanSeek { get; }
var CanSeek: Boolean { get{} }
Boolean CanSeek { __get; }
ReadOnly Property CanSeek() As Boolean
CanWrite virtual
Implementations should return true if this stream can be written to.
property CanWrite: Boolean read;
Boolean CanWrite { get; }
var CanWrite: Boolean { get{} }
Boolean CanWrite { __get; }
ReadOnly Property CanWrite() As Boolean
Length virtual
Returns the length of this stream.
property Length: Int64 read;
Int64 Length { get; }
var Length: Int64 { get{} }
Int64 Length { __get; }
ReadOnly Property Length() As Int64
Position virtual
Returns the current position in this stream.
close Cooper
method close
void close()
func close()
void close()
Sub close()
Close virtual abstract Toffee
func Close(Close )
Parameters:
- :
CopyTo virtual
Copy the content of this stream to another
method CopyTo(Destination: Stream)
void CopyTo(Stream Destination)
func CopyTo(_ Destination: Stream)
void CopyTo(Stream Destination)
Sub CopyTo(Destination As Stream)
Parameters:
- Destination:
Dispose .NET, .NET Core 6.0, .NET Standard 2.0, Island
Close the stream and underlying resources.
method Dispose
void Dispose()
func Dispose()
Sub Dispose()
Flush virtual abstract .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2
Flush the data. Used with file streams to ensure the data is stored on disk
method Flush
void Flush()
func Flush()
void Flush()
Sub Flush()
Flush Flush() virtual abstract Toffee
func Flush(Flush )
Parameters:
- :
GetLength virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
Returns the length of this stream.
GetLength GetLength(): Int64 virtual Toffee
func GetLength(GetLength ) -> Int64
Parameters:
- :
GetPosition virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island, ToffeeV2
Returns the current position in this stream.
method GetPosition: Int64
Int64 GetPosition()
func GetPosition() -> Int64
Function GetPosition() As Int64
GetPosition GetPosition(): Int64 virtual Toffee
func GetPosition(GetPosition ) -> Int64
Parameters:
- :
Read from this stream. Returns the nr of bytes retreived., or 0 when the end has been reached.
Parameters:
- Buffer:
- Count:
Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.
Parameters:
- Buffer:
- Offset:
- Count:
ReadByte virtual .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2
Reads a byte or returns -1 if the stream has reached the end
method ReadByte: Int32
Int32 ReadByte()
func ReadByte() -> Int32
Integer ReadByte()
Function ReadByte() As Int32
Parameters:
- aResult:
ReadByte ReadByte(): Int32 virtual Toffee
func ReadByte(ReadByte ) -> Int32
Parameters:
- :
ReadGuid .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt16BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt16LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt32BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt32LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt64BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
ReadUInt64LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- aResult:
Seek virtual abstract
this method can be used to change the position of the stream, relative to the current position, start or end of the stream. Returns the new position.
method Seek(Offset: Int64; Origin: SeekOrigin): Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64
Int64 Seek(Int64 Offset, SeekOrigin Origin)
Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64
Parameters:
- Offset:
- Origin:
SetPosition virtual .NET, .NET Core 6.0, .NET Standard 2.0, Island
Sets the absolute position in the stream.
method SetPosition(Value: Int64)
void SetPosition(Int64 Value)
func SetPosition(_ Value: Int64)
Sub SetPosition(Value As Int64)
Parameters:
- Value:
Parameters:
- Buffer:
Writes data to the stream.
Parameters:
- Buffer:
- Count:
Writes data to the stream.
Parameters:
- Buffer:
- Offset:
- Count:
WriteByte virtual
Writes data to the stream.
method WriteByte(aValue: Byte)
void WriteByte(Byte aValue)
func WriteByte(_ aValue: Byte)
void WriteByte(Byte aValue)
Sub WriteByte(aValue As Byte)
Parameters:
- aValue:
WriteGuid .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt16BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt16LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt32BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt32LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt64BE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value:
WriteUInt64LE .NET, .NET Core 6.0, .NET Standard 2.0, Island, Toffee, ToffeeV2
Parameters:
- value: