1/*
2 * Copyright (C) 2023 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17import {Timestamp} from 'common/time';
18import {CoarseVersion} from './coarse_version';
19import {
20  CustomQueryParamTypeMap,
21  CustomQueryParserResultTypeMap,
22  CustomQueryType,
23} from './custom_query';
24import {AbsoluteEntryIndex, EntriesRange} from './index_types';
25import {TraceType} from './trace_type';
26
27export interface Parser<T> {
28  getCoarseVersion(): CoarseVersion;
29  getTraceType(): TraceType;
30  getLengthEntries(): number;
31  getTimestamps(): Timestamp[] | undefined;
32  getEntry(index: AbsoluteEntryIndex): Promise<T>;
33  customQuery<Q extends CustomQueryType>(
34    type: Q,
35    entriesRange: EntriesRange,
36    param?: CustomQueryParamTypeMap[Q],
37  ): Promise<CustomQueryParserResultTypeMap[Q]>;
38  getDescriptors(): string[];
39  getRealToMonotonicTimeOffsetNs(): bigint | undefined;
40  getRealToBootTimeOffsetNs(): bigint | undefined;
41  createTimestamps(): void;
42}
43