Class Stream`Abstract`

Hierarchy (View Summary)

Stream

Index

Constructors

Accessors

canRead canWrite canSeek length position

Methods

validateBufferArguments read write seek flush setLength copyTo dispose throwNotSupported

Constructors

constructor

new Stream(): Stream

Returns Stream

Accessors

`Abstract`canRead

get canRead(): boolean
Whether the stream supports reading.

Returns boolean
- Defined in src/io/stream.ts:21

`Abstract`canWrite

get canWrite(): boolean
Whether the stream supports writing.

Returns boolean
- Defined in src/io/stream.ts:23

`Abstract`canSeek

get canSeek(): boolean
Whether the stream supports seeking.

Returns boolean
- Defined in src/io/stream.ts:25

`Abstract`length

get length(): number
The length of the stream, in bytes.

Returns number
- Defined in src/io/stream.ts:28

`Abstract`position

get position(): number
The current position within the stream.

Returns number
- Defined in src/io/stream.ts:30
set position(value: number): void
Set the current position within the stream.
Parameters
- value: number
Returns void
- Defined in src/io/stream.ts:32

Methods

`Protected` `Static`validateBufferArguments

validateBufferArguments(buffer: Uint8Array, offset: number, count: number): void
Validate buffer, offset, and count arguments for stream read/write operations.
Parameters
- buffer: Uint8Array
  The buffer supplied by the caller.
- offset: number
  The starting offset in the buffer.
- count: number
  The number of bytes to read or write.
Returns void

Throws
offset or count does not specify a valid range in buffer.
- Defined in src/io/stream.ts:88

`Abstract`read

read(buffer: Uint8Array, offset: number, count: number): number
Read up to count bytes into buffer at offset; returns bytes read (0 only at end of stream).
Parameters
- buffer: Uint8Array
- offset: number
- count: number
Returns number
- Defined in src/io/stream.ts:38

`Abstract`write

write(buffer: Uint8Array, offset: number, count: number): void
Write count bytes from buffer starting at offset.
Parameters
- buffer: Uint8Array
- offset: number
- count: number
Returns void
- Defined in src/io/stream.ts:41

`Abstract`seek

seek(offset: number, origin: SeekOrigin): number
Set the position within the stream.
Parameters
- offset: number
  The offset relative to origin.
- origin: SeekOrigin
  The reference point used to obtain the new position.
Returns number
The new position within the stream.
- Defined in src/io/stream.ts:50

`Abstract`flush

flush(): void
Flush any buffered data.

Returns void
- Defined in src/io/stream.ts:55

`Abstract`setLength

setLength(value: number): void
Set the length of the stream.
Parameters
- value: number
  The desired length in bytes.
Returns void
- Defined in src/io/stream.ts:62

copyTo

copyTo(destination: Stream, bufferSize?: number): void
Copy data from this stream to another stream.
Parameters
- destination: Stream
  The stream that will receive the copied data.
- bufferSize: number = 4096
  The temporary buffer size to use while copying.
Returns void
- Defined in src/io/stream.ts:70

dispose

dispose(): void
Release resources. Base implementation does nothing.

Returns void
- Defined in src/io/stream.ts:78

`Protected`throwNotSupported

throwNotSupported(operation: string): never
Throw for an unsupported stream operation.
Parameters
- operation: string
  The unsupported operation name.
Returns never

Throws
Always thrown because the operation is unsupported.
- Defined in src/io/stream.ts:101