BinaryStream

Overview

Wrapper around stream to read/write binary data in little endian order.

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

constructor (Stream)

constructor(aStream: Stream)

BinaryStream(Stream aStream)

init(_ aStream: Stream)

BinaryStream(Stream aStream)

Sub New(aStream As Stream)

Parameters:

aStream:

constructor (Stream, Encoding)

constructor(aStream: Stream; aEncoding: Encoding)

BinaryStream(Stream aStream, Encoding aEncoding)

init(_ aStream: Stream, _ aEncoding: Encoding)

BinaryStream(Stream aStream, Encoding aEncoding)

Sub New(aStream As Stream, aEncoding As Encoding)

Parameters:

aStream:
aEncoding:

BaseStream

Returns the stream this wrapper is writing to/reading from.

property BaseStream: Stream read;

Stream BaseStream { get; }

var BaseStream: Stream { get{} }

Stream BaseStream { __get; }

ReadOnly Property BaseStream() As Stream

PeekChar .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Look ahead 1 character and returns it (or -1 if it's the end of teh stream)

method PeekChar: Int32

Int32 PeekChar()

func PeekChar() -> Int32

Integer PeekChar()

Function PeekChar() As Int32

PeekChar PeekChar(): Int32 virtual Toffee

func PeekChar(PeekChar ) -> Int32

Parameters:

Read .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Reads a single character from this stream, returns -1 if the end of the stream has been reached

method Read: Int32

Int32 Read()

func Read() -> Int32

Integer Read()

Function Read() As Int32

Read (Int32): array of Byte

Read an array of bytes from the stream.

method Read(Count: Int32): array of Byte

Byte[] Read(Int32 Count)

func Read(_ Count: Int32) -> Byte...

Byte[] Read(Integer Count)

Function Read(Count As Int32) As Byte()

Parameters:

Count:

Read Read(): Int32 virtual Toffee

func Read(Read ) -> Int32

Parameters:

ReadByte .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a byte from this stream.

method ReadByte: Byte

Byte ReadByte()

func ReadByte() -> Byte

Byte ReadByte()

Function ReadByte() As Byte

ReadByte ReadByte(): Byte virtual Toffee

func ReadByte(ReadByte ) -> Byte

Parameters:

ReadDouble .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a double from this stream.

method ReadDouble: Double

Double ReadDouble()

func ReadDouble() -> Double

Double ReadDouble()

Function ReadDouble() As Double

ReadDouble ReadDouble(): Double virtual Toffee

func ReadDouble(ReadDouble ) -> Double

Parameters:

ReadInt16 .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a 2 byte integer from this stream.

method ReadInt16: Int16

Int16 ReadInt16()

func ReadInt16() -> Int16

SmallInt ReadInt16()

Function ReadInt16() As Int16

ReadInt16 ReadInt16(): Int16 virtual Toffee

func ReadInt16(ReadInt16 ) -> Int16

Parameters:

ReadInt32 .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a 4 byte integer from this stream.

method ReadInt32: Int32

Int32 ReadInt32()

func ReadInt32() -> Int32

Integer ReadInt32()

Function ReadInt32() As Int32

ReadInt32 ReadInt32(): Int32 virtual Toffee

func ReadInt32(ReadInt32 ) -> Int32

Parameters:

ReadInt64 .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read an 8 byte integer from this stream.

method ReadInt64: Int64

Int64 ReadInt64()

func ReadInt64() -> Int64

Int64 ReadInt64()

Function ReadInt64() As Int64

ReadInt64 ReadInt64(): Int64 virtual Toffee

func ReadInt64(ReadInt64 ) -> Int64

Parameters:

ReadSByte .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a (signed) byte from this stream

method ReadSByte: SByte

SByte ReadSByte()

func ReadSByte() -> SByte

SByte ReadSByte()

Function ReadSByte() As SByte

ReadSByte ReadSByte(): SByte virtual Toffee

func ReadSByte(ReadSByte ) -> SByte

Parameters:

ReadSingle .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a single precision float from this stream.

method ReadSingle: Single

Single ReadSingle()

func ReadSingle() -> Single

Single ReadSingle()

Function ReadSingle() As Single

ReadSingle ReadSingle(): Single virtual Toffee

func ReadSingle(ReadSingle ) -> Single

Parameters:

ReadString

Read a string from this stream, count is the number of bytes to read.

method ReadString(Count: Int32): String

String ReadString(Int32 Count)

func ReadString(_ Count: Int32) -> String

String ReadString(Integer Count)

Function ReadString(Count As Int32) As String

Parameters:

Count:

Write (array of Byte, Int32, Int32)

Write binary data to the stream.

method Write(aValue: array of Byte; Offset: Int32; Count: Int32)

void Write(Byte[] aValue, Int32 Offset, Int32 Count)

func Write(_ aValue: Byte..., _ Offset: Int32, _ Count: Int32)

void Write(Byte[] aValue, Integer Offset, Integer Count)

Sub Write(aValue As Byte(), Offset As Int32, Count As Int32)

Parameters:

aValue:
Offset:
Count:

Write (Byte)

Write a byte to this stream.

method Write(aValue: Byte)

void Write(Byte aValue)

func Write(_ aValue: Byte)

void Write(Byte aValue)

Sub Write(aValue As Byte)

Parameters:

aValue:

WriteByte

Write a byte to this stream.

method WriteByte(Value: Byte)

void WriteByte(Byte Value)

func WriteByte(_ Value: Byte)

void WriteByte(Byte Value)

Sub WriteByte(Value As Byte)

Parameters:

Value:

WriteDouble

Write a double to this stream.

method WriteDouble(Value: Double)

void WriteDouble(Double Value)

func WriteDouble(_ Value: Double)

void WriteDouble(Double Value)

Sub WriteDouble(Value As Double)

Parameters:

Value:

WriteInt16

Write an int16 to this stream.

method WriteInt16(Value: Int16)

void WriteInt16(Int16 Value)

func WriteInt16(_ Value: Int16)

void WriteInt16(SmallInt Value)

Sub WriteInt16(Value As Int16)

Parameters:

Value:

WriteInt32

Write an int32 to this stream.

method WriteInt32(Value: Int32)

void WriteInt32(Int32 Value)

func WriteInt32(_ Value: Int32)

void WriteInt32(Integer Value)

Sub WriteInt32(Value As Int32)

Parameters:

Value:

WriteInt64

Write an int64 to this stream.

method WriteInt64(Value: Int64)

void WriteInt64(Int64 Value)

func WriteInt64(_ Value: Int64)

void WriteInt64(Int64 Value)

Sub WriteInt64(Value As Int64)

Parameters:

Value:

WriteSByte

Write a signed byte to this stream.

method WriteSByte(Value: SByte)

void WriteSByte(SByte Value)

func WriteSByte(_ Value: SByte)

void WriteSByte(SByte Value)

Sub WriteSByte(Value As SByte)

Parameters:

Value:

WriteSingle

Write a string to this stream.

method WriteSingle(Value: Single)

void WriteSingle(Single Value)

func WriteSingle(_ Value: Single)

void WriteSingle(Single Value)

Sub WriteSingle(Value As Single)

Parameters:

Value:

WriteString

Write a string to this stream.

method WriteString(aString: String)

void WriteString(String aString)

func WriteString(_ aString: String)

void WriteString(String aString)

Sub WriteString(aString As String)

Parameters:

aString:

BaseStream

Returns the stream this wrapper is writing to/reading from.

property BaseStream: Stream read;

Stream BaseStream { get; }

var BaseStream: Stream { get{} }

Stream BaseStream { __get; }

ReadOnly Property BaseStream() As Stream

constructor (Stream)

constructor(aStream: Stream)

BinaryStream(Stream aStream)

init(_ aStream: Stream)

BinaryStream(Stream aStream)

Sub New(aStream As Stream)

Parameters:

aStream:

constructor (Stream, Encoding)

constructor(aStream: Stream; aEncoding: Encoding)

BinaryStream(Stream aStream, Encoding aEncoding)

init(_ aStream: Stream, _ aEncoding: Encoding)

BinaryStream(Stream aStream, Encoding aEncoding)

Sub New(aStream As Stream, aEncoding As Encoding)

Parameters:

aStream:
aEncoding:

PeekChar .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Look ahead 1 character and returns it (or -1 if it's the end of teh stream)

method PeekChar: Int32

Int32 PeekChar()

func PeekChar() -> Int32

Integer PeekChar()

Function PeekChar() As Int32

PeekChar PeekChar(): Int32 virtual Toffee

func PeekChar(PeekChar ) -> Int32

Parameters:

Read .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Reads a single character from this stream, returns -1 if the end of the stream has been reached

method Read: Int32

Int32 Read()

func Read() -> Int32

Integer Read()

Function Read() As Int32

Read (Int32): array of Byte

Read an array of bytes from the stream.

method Read(Count: Int32): array of Byte

Byte[] Read(Int32 Count)

func Read(_ Count: Int32) -> Byte...

Byte[] Read(Integer Count)

Function Read(Count As Int32) As Byte()

Parameters:

Count:

Read Read(): Int32 virtual Toffee

func Read(Read ) -> Int32

Parameters:

ReadByte .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a byte from this stream.

method ReadByte: Byte

Byte ReadByte()

func ReadByte() -> Byte

Byte ReadByte()

Function ReadByte() As Byte

ReadByte ReadByte(): Byte virtual Toffee

func ReadByte(ReadByte ) -> Byte

Parameters:

ReadDouble .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a double from this stream.

method ReadDouble: Double

Double ReadDouble()

func ReadDouble() -> Double

Double ReadDouble()

Function ReadDouble() As Double

ReadDouble ReadDouble(): Double virtual Toffee

func ReadDouble(ReadDouble ) -> Double

Parameters:

ReadInt16 .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a 2 byte integer from this stream.

method ReadInt16: Int16

Int16 ReadInt16()

func ReadInt16() -> Int16

SmallInt ReadInt16()

Function ReadInt16() As Int16

ReadInt16 ReadInt16(): Int16 virtual Toffee

func ReadInt16(ReadInt16 ) -> Int16

Parameters:

ReadInt32 .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a 4 byte integer from this stream.

method ReadInt32: Int32

Int32 ReadInt32()

func ReadInt32() -> Int32

Integer ReadInt32()

Function ReadInt32() As Int32

ReadInt32 ReadInt32(): Int32 virtual Toffee

func ReadInt32(ReadInt32 ) -> Int32

Parameters:

ReadInt64 .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read an 8 byte integer from this stream.

method ReadInt64: Int64

Int64 ReadInt64()

func ReadInt64() -> Int64

Int64 ReadInt64()

Function ReadInt64() As Int64

ReadInt64 ReadInt64(): Int64 virtual Toffee

func ReadInt64(ReadInt64 ) -> Int64

Parameters:

ReadSByte .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a (signed) byte from this stream

method ReadSByte: SByte

SByte ReadSByte()

func ReadSByte() -> SByte

SByte ReadSByte()

Function ReadSByte() As SByte

ReadSByte ReadSByte(): SByte virtual Toffee

func ReadSByte(ReadSByte ) -> SByte

Parameters:

ReadSingle .NET, .NET Core 6.0, .NET Standard 2.0, Cooper, Island, ToffeeV2

Read a single precision float from this stream.

method ReadSingle: Single

Single ReadSingle()

func ReadSingle() -> Single

Single ReadSingle()

Function ReadSingle() As Single

ReadSingle ReadSingle(): Single virtual Toffee

func ReadSingle(ReadSingle ) -> Single

Parameters:

ReadString

Read a string from this stream, count is the number of bytes to read.

method ReadString(Count: Int32): String

String ReadString(Int32 Count)

func ReadString(_ Count: Int32) -> String

String ReadString(Integer Count)

Function ReadString(Count As Int32) As String

Parameters:

Count:

Write (array of Byte, Int32, Int32)

Write binary data to the stream.

method Write(aValue: array of Byte; Offset: Int32; Count: Int32)

void Write(Byte[] aValue, Int32 Offset, Int32 Count)

func Write(_ aValue: Byte..., _ Offset: Int32, _ Count: Int32)

void Write(Byte[] aValue, Integer Offset, Integer Count)

Sub Write(aValue As Byte(), Offset As Int32, Count As Int32)

Parameters:

aValue:
Offset:
Count:

Write (Byte)

Write a byte to this stream.

method Write(aValue: Byte)

void Write(Byte aValue)

func Write(_ aValue: Byte)

void Write(Byte aValue)

Sub Write(aValue As Byte)

Parameters:

aValue:

WriteByte

Write a byte to this stream.

method WriteByte(Value: Byte)

void WriteByte(Byte Value)

func WriteByte(_ Value: Byte)

void WriteByte(Byte Value)

Sub WriteByte(Value As Byte)

Parameters:

Value:

WriteDouble

Write a double to this stream.

method WriteDouble(Value: Double)

void WriteDouble(Double Value)

func WriteDouble(_ Value: Double)

void WriteDouble(Double Value)

Sub WriteDouble(Value As Double)

Parameters:

Value:

WriteInt16

Write an int16 to this stream.

method WriteInt16(Value: Int16)

void WriteInt16(Int16 Value)

func WriteInt16(_ Value: Int16)

void WriteInt16(SmallInt Value)

Sub WriteInt16(Value As Int16)

Parameters:

Value:

WriteInt32

Write an int32 to this stream.

method WriteInt32(Value: Int32)

void WriteInt32(Int32 Value)

func WriteInt32(_ Value: Int32)

void WriteInt32(Integer Value)

Sub WriteInt32(Value As Int32)

Parameters:

Value:

WriteInt64

Write an int64 to this stream.

method WriteInt64(Value: Int64)

void WriteInt64(Int64 Value)

func WriteInt64(_ Value: Int64)

void WriteInt64(Int64 Value)

Sub WriteInt64(Value As Int64)

Parameters:

Value:

WriteSByte

Write a signed byte to this stream.

method WriteSByte(Value: SByte)

void WriteSByte(SByte Value)

func WriteSByte(_ Value: SByte)

void WriteSByte(SByte Value)

Sub WriteSByte(Value As SByte)

Parameters:

Value:

WriteSingle

Write a string to this stream.

method WriteSingle(Value: Single)

void WriteSingle(Single Value)

func WriteSingle(_ Value: Single)

void WriteSingle(Single Value)

Sub WriteSingle(Value As Single)

Parameters:

Value:

WriteString

Write a string to this stream.

method WriteString(aString: String)

void WriteString(String aString)

func WriteString(_ aString: String)

void WriteString(String aString)

Sub WriteString(aString As String)

Parameters:

aString: