Class Resource<ID>`Internal`

The cache for a specific resource

Type Parameters

ID

Index

Constructors

Properties

_size id options regions

Accessors

Methods

add cached collect collectAt indexAfter mergeAt missing regionAt regionsIn resizeRegion

Constructors

constructor

new Resource<ID>(
    id: ID,
    _size: number,
    options: Options,
    resources?: Map<ID, Resource<ID> | undefined>,
): Resource<ID>
Type Parameters
- ID
Parameters
- id: ID
  The resource ID
- _size: number
- options: Options
- Optionalresources: Map<ID, Resource<ID> | undefined>
Returns Resource<ID>
- Defined in src/cache.ts:118

Properties

`Protected`_size

_size: number

`Readonly`id

id: ID

The resource ID

`Protected` `Readonly`options

options: Options

`Readonly`regions

regions: Region[] = []

Regions used to reduce unneeded allocations. Think of sparse arrays.

Accessors

size

get size(): number
The full size of the resource

Returns number
- Defined in src/cache.ts:82
set size(value: number): void
Parameters
- value: number
Returns void
- Defined in src/cache.ts:86

Methods

add

add(data: Uint8Array, offset: number): this
Add new data to the cache at given specified offset
Parameters
- data: Uint8Array
- offset: number
Returns this
- Defined in src/cache.ts:281

cached

cached(start: number, end: number): Range[]
Get the cached sub-ranges of an initial range. This is conceptually the inverse of missing.
Parameters
- start: number
- end: number
Returns Range[]
- Defined in src/cache.ts:222

collect

collect(): void
Combines adjacent regions and combines adjacent ranges within a region

Returns void
- Defined in src/cache.ts:175

`Protected`collectAt

collectAt(index: number): void
Combine the region at index with the neighbors it now reaches. Only that region can have changed, so this does not re-walk the whole list the way collect does.
Parameters
- index: number
Returns void
- Defined in src/cache.ts:184

`Protected`indexAfter

indexAfter(offset: number): number
Index of the first region positioned after offset. Regions are kept sorted, so this is a binary search.
Parameters
- offset: number
Returns number
- Defined in src/cache.ts:252

`Protected`mergeAt

mergeAt(index: number): boolean
Merge the region after index into the one at index, if the gap between them is small enough
Parameters
- index: number
Returns boolean
- Defined in src/cache.ts:156

missing

missing(start: number, end: number): Range[]
Takes an initial range and finds the sub-ranges that are not in the cache
Parameters
- start: number
- end: number
Returns Range[]
- Defined in src/cache.ts:191

regionAt

regionAt(offset: number): Region | undefined
Get the region who's ranges include an offset
Parameters
- offset: number
Returns Region | undefined
- Defined in src/cache.ts:266

regionsIn

regionsIn(start: number, end: number): Generator<Region>
The regions overlapping [start, end), in order. Seeks to the first one rather than scanning from the start.
Parameters
- start: number
- end: number
Returns Generator<Region>
- Defined in src/cache.ts:272

`Protected`resizeRegion

resizeRegion(region: Region, length: number): void
Resize region.data to length bytes. Capacity can be over-allocated geometrically so appending to a region repeatedly stays amortized O(1).
Parameters
- region: Region
- length: number
Returns void
- Defined in src/cache.ts:142