Stream

Overview

Base stream implementation. Streams can be used to seek, read and write from a foreign resource.

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL

Descendants

 

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; }

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; }

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; }

Close  virtual abstract

Close the stream and underlying resources.

 

method Close

 

void Close()

 

func Close()

 

void Close()

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)

Parameters:

  • Destination:

Dispose .NET, .NET Standard 2.0, Island

Close the stream and underlying resources.

 

method Dispose

 

void Dispose()

 

func Dispose()

Flush  virtual abstract

Flush the data. Used with file streams to ensure the data is stored on disk

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

GetLength  virtual .NET, .NET Standard 2.0, Island, Toffee, ToffeeV2

Returns the length of this stream.

 

method GetLength: Int64

 

Int64 GetLength()

 

func GetLength() -> Int64

GetPosition  virtual .NET, .NET Standard 2.0, Island, Toffee, ToffeeV2

Returns the current position in this stream.

 

method GetPosition: Int64

 

Int64 GetPosition()

 

func GetPosition() -> Int64

Length  virtual

Returns the length of this stream.

 

property Length: Int64 read;

 

Int64 Length { get; }

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

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; }

Read (array of Byte, Int32): Int32

Read from this stream. Returns the nr of bytes retreived., or 0 when the end has been reached.

 

method Read(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Count)

 

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

 

Integer Read(Byte[] Buffer, Integer Count)

Parameters:

  • Buffer:
  • Count:

Read (array of Byte, Int32, Int32): Int32  virtual abstract

Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.

 

method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)

 

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

 

Integer Read(Byte[] Buffer, Integer Offset, Integer Count)

Parameters:

  • Buffer:
  • Offset:
  • Count:

ReadByte  virtual

Reads a byte or returns -1 if the stream has reached the end

 

method ReadByte: Int32

 

Int32 ReadByte()

 

func ReadByte() -> Int32

 

Integer ReadByte()

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)

Parameters:

  • Offset:
  • Origin:

SetPosition  virtual .NET, .NET Standard 2.0, Island

Sets the absolute position in the stream.

 

method SetPosition(Value: Int64)

 

void SetPosition(Int64 Value)

 

func SetPosition(_ Value: Int64)

Parameters:

  • Value:

Write (array of Byte, Int32): Int32

Writes data to the stream.

 

method Write(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Write(Byte[] Buffer, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Count)

Parameters:

  • Buffer:
  • Count:

Write (array of Byte, Int32, Int32): Int32  virtual abstract

Writes data to the stream.

 

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

 

Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Offset, Integer Count)

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)

Parameters:

  • aValue:

 

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; }

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; }

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; }

Length  virtual

Returns the length of this stream.

 

property Length: Int64 read;

 

Int64 Length { get; }

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

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; }

 

Close  virtual abstract

Close the stream and underlying resources.

 

method Close

 

void Close()

 

func Close()

 

void Close()

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)

Parameters:

  • Destination:

Dispose .NET, .NET Standard 2.0, Island

Close the stream and underlying resources.

 

method Dispose

 

void Dispose()

 

func Dispose()

Flush  virtual abstract

Flush the data. Used with file streams to ensure the data is stored on disk

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

GetLength  virtual .NET, .NET Standard 2.0, Island, Toffee, ToffeeV2

Returns the length of this stream.

 

method GetLength: Int64

 

Int64 GetLength()

 

func GetLength() -> Int64

GetPosition  virtual .NET, .NET Standard 2.0, Island, Toffee, ToffeeV2

Returns the current position in this stream.

 

method GetPosition: Int64

 

Int64 GetPosition()

 

func GetPosition() -> Int64

Read (array of Byte, Int32): Int32

Read from this stream. Returns the nr of bytes retreived., or 0 when the end has been reached.

 

method Read(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Count)

 

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

 

Integer Read(Byte[] Buffer, Integer Count)

Parameters:

  • Buffer:
  • Count:

Read (array of Byte, Int32, Int32): Int32  virtual abstract

Read from this stream. Returns the nr of bytes retreived, or 0 when the end has been reached.

 

method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)

 

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

 

Integer Read(Byte[] Buffer, Integer Offset, Integer Count)

Parameters:

  • Buffer:
  • Offset:
  • Count:

ReadByte  virtual

Reads a byte or returns -1 if the stream has reached the end

 

method ReadByte: Int32

 

Int32 ReadByte()

 

func ReadByte() -> Int32

 

Integer ReadByte()

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)

Parameters:

  • Offset:
  • Origin:

SetPosition  virtual .NET, .NET Standard 2.0, Island

Sets the absolute position in the stream.

 

method SetPosition(Value: Int64)

 

void SetPosition(Int64 Value)

 

func SetPosition(_ Value: Int64)

Parameters:

  • Value:

Write (array of Byte, Int32): Int32

Writes data to the stream.

 

method Write(Buffer: array of Byte; Count: Int32): Int32

 

Int32 Write(Byte[] Buffer, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Count)

Parameters:

  • Buffer:
  • Count:

Write (array of Byte, Int32, Int32): Int32  virtual abstract

Writes data to the stream.

 

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

 

Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Integer Write(Byte[] Buffer, Integer Offset, Integer Count)

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)

Parameters:

  • aValue:

Descendants