跳到主要内容

RxDBBackupArchiveReader

Defined in: packages/rxdb/src/backup/backup-archive.ts:306

流式归档读取器。

Remarks​

先 readManifest,再反复 next 直到 end。所有结构问题在产出之前就地判定: 魔数、帧类型与顺序、帧长度上限(越界时不等待、不分配)、路径安全与唯一、条目字节数、 结束标记与 SHA-256、结束标记之后不得再有字节。输入在结束标记之前耗尽报 truncated_archive, 其余损坏报 corrupt_archive 并在 details.field 标注位置;输入流自身失败报 io_error。

摘要只有读到结尾才知道,所以 manifest 和数据在校验摘要之前就已产出——调用方必须把它们 写进可丢弃的暂存区,等到 end 之后才能提交。读取器不取消底层流,由调用方处置。

Constructors​

Constructor​

new RxDBBackupArchiveReader(source, signal?): RxDBBackupArchiveReader;

Defined in: packages/rxdb/src/backup/backup-archive.ts:319

Parameters​

ParameterType
sourceReadableStreamDefaultReader<Uint8Array<ArrayBufferLike>>
signal?AbortSignal

Returns​

RxDBBackupArchiveReader

Methods​

next()​

next(): Promise<RxDBBackupArchiveItem>;

Defined in: packages/rxdb/src/backup/backup-archive.ts:348

读取下一项。

Returns​

Promise<RxDBBackupArchiveItem>

条目头、数据片段或结束


readManifest()​

readManifest(): Promise<RxDBBackupManifest>;

Defined in: packages/rxdb/src/backup/backup-archive.ts:329

读取并校验魔数与 manifest 的结构(兼容性判定由调用方负责)。

Returns​

Promise<RxDBBackupManifest>

结构合格的 manifest