/** * NVL is a null coalescing function required for STEP. * * @param testValue The value to test. * @param replaceValue The value to replace it with if the test fails. * @return {any | null | undefined} Test value if it's not nullish, replaceValue otherwise. */ export declare function NVL(testValue: T | null | undefined, replaceValue: T): T; /** * Return the Hi Index of an array (Express expects 1 based here, so it's length). * * @param testValue The value try and get a length from. * @return {number} The length if this is a valid array, or 0 otherwise. */ export declare function HIINDEX(testValue: T[] | null | undefined): number; /** * Return the size of an array * * @param testValue The value try and get a length from. * @return {number} The length if this is a valid array, or 0 otherwise. */ export declare function SIZEOF(testValue: T[] | null | undefined): number; /** * Step try and extract an optional value (null). * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {null | undefined} Null if this is optional, undefined otherwise. */ export declare function stepExtractOptional(buffer: Uint8Array, cursor: number, endCursor: number): null | undefined; /** * Extract a STEP number * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {number | undefined} The number if it can be extracted, undefined otherwise. */ export declare function stepExtractNumber(buffer: Uint8Array, cursor: number, endCursor: number): number | undefined; /** * Extract a STEP logical value (which can be true, false or unknown) * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {boolean | null | undefined} The boolean if it can be extracted, null for unknown * and undefined if the value can't be extracted. */ export declare function stepExtractLogical(buffer: Uint8Array, cursor: number, endCursor: number): boolean | null | undefined; /** * Extract a STEP boolean value (which can be true or false) * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {boolean | undefined} The boolean if it can be extracted * and undefined if the value can't be extracted. */ export declare function stepExtractBoolean(buffer: Uint8Array, cursor: number, endCursor: number): boolean | undefined; /** * Skip a value in the parse (doesn't apply to arrays, just flat), * either til the next array end (close bracket) or the next comma. * * @param buffer The buffer to read from. * @param cursor The current read cursor. * @param endCursor The highest possible cursor to read from. * @throws {Error} When the parse syntax is incorrect. * @return {number} The new cursor. */ export declare function skipValue(buffer: Uint8Array, cursor: number, endCursor: number): number; /** * Extract a STEP an array (iterable set of indices to array values to extract) * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {number} Returns a negative number on termination/error * matching the values in IncermentalParseEndState, or the new cursor * if there is a value in . */ export declare function stepExtractArrayBegin(buffer: Uint8Array, cursor: number, endCursor: number): number; /** * Extract a STEP an array (iterable set of indices to array values to extract) * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {number} Returns a negative number on termination/error * matching the values in IncermentalParseEndState, or the new cursor * if there is a value in the token. */ export declare function stepExtractArrayToken(buffer: Uint8Array, cursor: number, endCursor: number): number; /** * Extract a STEP an array (iterable set of indices to array values to extract) * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @throws {Error} If there is a syntax error, an error is thrown. * @yields {number} The index for each entry. * @return {IterableIterator} Lazy iterator to extract value. */ export declare function stepExtractArray(buffer: Uint8Array, cursor: number, endCursor: number): IterableIterator; /** * Extracts an inline element and returns its cursor, or none if it can't be found. * * @param buffer The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {number | undefined} The index address of the start of the inline element, or * undefined if one can't be found. */ export declare function stepExtractInlineElemement(buffer: Uint8Array, cursor: number, endCursor: number): number | undefined; /** * Match an unsigned integer and return the updated cursor position or * undefined if no match is found * * @param input The buffer to extract it from. * @param cursor The position in the buffer to try and extract it from. * @param endCursor The last position accessible for this read in the buffer. * @return {number | undefined} The reference express ID of the start of the inline element, or * undefined if one can't be found. */ export declare function stepExtractReference(input: Uint8Array, cursor: number, endCursor: number): number | undefined; declare const stepExtractEnum: (typeMap: import("../../indexing/minimal_perfect_hash.js").default, input: Uint8Array, cursor: number, endCursor: number) => T | undefined; export { stepExtractEnum }; declare const stepExtractString: (input: Uint8Array, cursor: number, endCursor: number, codePage?: number) => string | undefined; export { stepExtractString }; declare const stepExtractBinary: (input: Uint8Array, cursor: number, endCursor: number) => [ Uint8Array, number ] | undefined; export { stepExtractBinary }; //# sourceMappingURL=step_deserialization_functions.d.ts.map