Class BufferChunkSource

Generate chunks from a fixed buffer.

Hierarchy

KnownSizeChunkSource
- BufferChunkSource

Implements

ChunkSource

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BufferChunkSource(input: Uint8Array, opts?: ChunkOptions): BufferChunkSource

Overrides KnownSizeChunkSource.constructor
- Defined in packages/segmented-object/src/serve/chunk-source/buffer.ts:5
Parameters
- input: Uint8Array
- opts: ChunkOptions = {}
Returns BufferChunkSource

Properties

Protected Readonly chunkSize

chunkSize: number

Protected Readonly final

final: number

Protected Readonly finalChunkSize

finalChunkSize: number

Protected Readonly totalSize

totalSize: number

Methods

getChunk

getChunk(i: number): Promise<undefined | Chunk>

Implementation of ChunkSource.getChunk
Inherited from KnownSizeChunkSource.getChunk
- Defined in packages/segmented-object/src/serve/chunk-source/common.ts:55
Generate a chunk on-demand.

Parameters
- i: number
Returns Promise<undefined | Chunk>
a Promise that resolves to requested chunk, or undefined if out of range.

Protected getPayload

getPayload(i: number, offset: number, chunkSize: number): Promise<Uint8Array>

Overrides KnownSizeChunkSource.getPayload
- Defined in packages/segmented-object/src/serve/chunk-source/buffer.ts:9
Parameters
- i: number
- offset: number
- chunkSize: number
Returns Promise<Uint8Array>

listChunks

listChunks(): AsyncIterable<Chunk>

Implementation of ChunkSource.listChunks
Inherited from KnownSizeChunkSource.listChunks
- Defined in packages/segmented-object/src/serve/chunk-source/common.ts:48
Generate chunks sequentially.

Returns AsyncIterable<Chunk>
an AsyncIterable of chunks in order.

Generated using TypeDoc