Interface StepBufferProvider

Residency provider for a model's source bytes.

interface StepBufferProvider {
    byteLength: number;
    residentBytes: number;
    acquire(address: number, length: number): StepBufferAcquisition;
    ensureResident(address: number, length: number): Promise<void>;
}

Implemented by

Properties

byteLength residentBytes

Methods

acquire ensureResident

Properties

ReadonlybyteLength

byteLength: number

Total logical size of the source bytes.

ReadonlyresidentBytes

residentBytes: number

Bytes currently held resident by the provider itself.

Methods

acquire

  • acquire(address, length): StepBufferAcquisition

  • Synchronously acquire a view containing a byte range.

    Parameters

    • address: number

      Absolute start of the range.

    • length: number

      Length of the range.

    Returns StepBufferAcquisition

    The view and its base address.

    Throws

    When the range isn't resident.

ensureResident

  • ensureResident(address, length): Promise<void>

  • Make a byte range resident so a following acquire succeeds.

    Parameters

    • address: number

      Absolute start of the range.

    • length: number

      Length of the range.

    Returns Promise<void>

    Resolves when resident.

Settings

Member Visibility

On This Page

Properties
Methods