mirror of
https://github.com/rhinstaller/node-cache.git
synced 2026-11-03 21:49:47 -09:00
48 lines
1.9 KiB
TypeScript
48 lines
1.9 KiB
TypeScript
import { type DescField, type DescMessage } from "./descriptors.js";
|
|
import type { MessageShape } from "./types.js";
|
|
import type { ReflectMessage } from "./reflect/index.js";
|
|
import { BinaryReader, WireType } from "./wire/binary-encoding.js";
|
|
/**
|
|
* Options for parsing binary data.
|
|
*/
|
|
export interface BinaryReadOptions {
|
|
/**
|
|
* Retain unknown fields during parsing? The default behavior is to retain
|
|
* unknown fields and include them in the serialized output.
|
|
*
|
|
* For more details see https://developers.google.com/protocol-buffers/docs/proto3#unknowns
|
|
*/
|
|
readUnknownFields: boolean;
|
|
/**
|
|
* The maximum depth of nested messages to parse. If a message nests deeper
|
|
* than this limit, parsing fails with an error instead of exhausting the
|
|
* call stack. Defaults to 100.
|
|
*/
|
|
recursionLimit: number;
|
|
}
|
|
interface BinaryReadContext extends BinaryReadOptions {
|
|
depth: number;
|
|
}
|
|
/**
|
|
* @private Only exported for getExtension()
|
|
*/
|
|
export declare function makeReadContext(options?: Partial<BinaryReadOptions>): BinaryReadContext;
|
|
/**
|
|
* Parse serialized binary data.
|
|
*/
|
|
export declare function fromBinary<Desc extends DescMessage>(schema: Desc, bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MessageShape<Desc>;
|
|
/**
|
|
* Parse from binary data, merging fields.
|
|
*
|
|
* Repeated fields are appended. Map entries are added, overwriting
|
|
* existing keys.
|
|
*
|
|
* If a message field is already present, it will be merged with the
|
|
* new data.
|
|
*/
|
|
export declare function mergeFromBinary<Desc extends DescMessage>(schema: Desc, target: MessageShape<Desc>, bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MessageShape<Desc>;
|
|
/**
|
|
* @private Only exported for getExtension()
|
|
*/
|
|
export declare function readField(message: ReflectMessage, reader: BinaryReader, field: DescField, wireType: WireType, ctx: BinaryReadContext): void;
|
|
export {};
|