FileStream

Overview

Stream implementation for file access.

Location

  • Reference:
    • Elements.dll  .NET, .NET Standard 2.0
    • elements.jar  Cooper
    • Elements.fx  Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, ToffeeV2
    • libElements.fx  Toffee
  • Namespace: RemObjects.Elements.RTL
  • Platforms: .NET, .NET Standard 2.0, Cooper, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows, Toffee, ToffeeV2
  • Ancestry:
    • Stream | WrappedPlatformStream | FileStream  .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows
    • Stream | FileStream  Cooper, Toffee, ToffeeV2

 

constructor  protected    (declared in WrappedPlatformStream) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

constructor

 

FileStream()

 

init()

CanRead  override

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  override

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  override

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  override

Close the stream and underlying resources.

 

method Close

 

void Close()

 

func Close()

 

void Close()

CopyTo  virtual    (declared in Stream)

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    (declared in Stream) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

Close the stream and underlying resources.

 

method Dispose

 

void Dispose()

 

func Dispose()

Flush  override

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

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

GetLength  override Toffee, ToffeeV2

Returns the length of this stream.

 

func GetLength() -> Int64

GetPosition  override Toffee, ToffeeV2

Returns the current position in this stream.

 

func GetPosition() -> Int64

Length  override Cooper, Toffee, ToffeeV2

Returns the length of this stream.

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

Position  override Cooper, Toffee, ToffeeV2

Returns the current position in this stream.

 

var Position: Int64 { get{} set{} }

 

Int64 Position { __get; __set; }

Read (array of Byte, Int32): Int32    (declared in Stream)

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, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

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

 

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

 

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

Parameters:

  • Buffer:
  • Offset:
  • Count:

ReadByte  virtual    (declared in Stream)

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

 

method ReadByte: Int32

 

Int32 ReadByte()

 

func ReadByte() -> Int32

 

Integer ReadByte()

Seek  override Cooper, Toffee, ToffeeV2

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.

 

func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

Parameters:

  • Offset:
  • Origin:

SetLength Cooper, Toffee, ToffeeV2

Changes the length of a filestream, reseves the data on disk.

 

func SetLength(_ Value: Int64)

 

void SetLength(Int64 Value)

Parameters:

  • Value:

SetPosition  override virtual    (declared in WrappedPlatformStream) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

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    (declared in Stream)

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, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

Writes data to the stream.

 

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

 

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

Parameters:

  • Buffer:
  • Offset:
  • Count:

WriteByte  virtual    (declared in Stream)

Writes data to the stream.

 

method WriteByte(aValue: Byte)

 

void WriteByte(Byte aValue)

 

func WriteByte(_ aValue: Byte)

 

void WriteByte(Byte aValue)

Parameters:

  • aValue:

 

CanRead  override

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  override

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  override

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  override Cooper, Toffee, ToffeeV2

Returns the length of this stream.

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

Position  override Cooper, Toffee, ToffeeV2

Returns the current position in this stream.

 

var Position: Int64 { get{} set{} }

 

Int64 Position { __get; __set; }

 

constructor  protected    (declared in WrappedPlatformStream) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

 

constructor

 

FileStream()

 

init()

Close  override

Close the stream and underlying resources.

 

method Close

 

void Close()

 

func Close()

 

void Close()

CopyTo  virtual    (declared in Stream)

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    (declared in Stream) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

Close the stream and underlying resources.

 

method Dispose

 

void Dispose()

 

func Dispose()

Flush  override

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

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

GetLength  override Toffee, ToffeeV2

Returns the length of this stream.

 

func GetLength() -> Int64

GetPosition  override Toffee, ToffeeV2

Returns the current position in this stream.

 

func GetPosition() -> Int64

Read (array of Byte, Int32): Int32    (declared in Stream)

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, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

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

 

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

 

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

Parameters:

  • Buffer:
  • Offset:
  • Count:

ReadByte  virtual    (declared in Stream)

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

 

method ReadByte: Int32

 

Int32 ReadByte()

 

func ReadByte() -> Int32

 

Integer ReadByte()

Seek  override Cooper, Toffee, ToffeeV2

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.

 

func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

Parameters:

  • Offset:
  • Origin:

SetLength Cooper, Toffee, ToffeeV2

Changes the length of a filestream, reseves the data on disk.

 

func SetLength(_ Value: Int64)

 

void SetLength(Int64 Value)

Parameters:

  • Value:

SetPosition  override virtual    (declared in WrappedPlatformStream) .NET, .NET Standard 2.0, Island-Android, Island-iOS, Island-iOS Simulator-x86_64, Island-macOS-x86_64, Island-tvOS, Island-tvOS Simulator-x86_64, Island-Ubuntu, Island-UIKit for Mac-x86_64, Island-watchOS, Island-watchOS Simulator, Island-Windows

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    (declared in Stream)

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, Integer, Integer): Integer  override Cooper, Toffee, ToffeeV2

Writes data to the stream.

 

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

 

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

Parameters:

  • Buffer:
  • Offset:
  • Count:

WriteByte  virtual    (declared in Stream)

Writes data to the stream.

 

method WriteByte(aValue: Byte)

 

void WriteByte(Byte aValue)

 

func WriteByte(_ aValue: Byte)

 

void WriteByte(Byte aValue)

Parameters:

  • aValue: