About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Stream

Provides a generic view of a sequence of bytes. This is an abstract class.

Hierarchy (View Summary)

System.Object
- Stream
  - MemoryStream

Index

Accessors

CanRead CanSeek CanWrite Length Position

Methods

Cast Equals GetHashCode Seek ToString TryCast Equals

Accessors

CanRead

get CanRead(): boolean
When overridden in a derived class, gets a value indicating whether the current stream supports reading.

Returns boolean
true if the stream supports reading; otherwise, false.

CanSeek

get CanSeek(): boolean
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

Returns boolean
true if the stream supports seeking; otherwise, false.

CanWrite

get CanWrite(): boolean
When overridden in a derived class, gets a value indicating whether the current stream supports writing.

Returns boolean
true if the stream supports writing; otherwise, false.

Length

get Length(): number
When overridden in a derived class, gets the length in bytes of the stream.

Returns number
A long value representing the length of the stream in bytes.

Position

get Position(): number
When overridden in a derived class, gets or sets the position within the current stream.

Returns number
The current position within the stream.
set Position(value: number): void
Parameters
- value: number
Returns void

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

Seek

Seek(offset: number | Int64, origin: SeekOrigin): number
When overridden in a derived class, sets the position within the current stream.
Parameters
- offset: number | Int64
  A byte offset relative to the origin parameter.
- origin: SeekOrigin
  A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.
Returns number
The new position within the current stream.

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals