• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
17 package android.tools.common
18 
19 import kotlin.js.JsExport
20 import kotlin.js.JsName
21 
22 @JsExport
23 interface ITrace<Entry : ITraceEntry> {
24     @JsName("entries") val entries: Array<Entry>
25 
slicenull26     @JsName("slice") fun slice(startTimestamp: Timestamp, endTimestamp: Timestamp): ITrace<Entry>
27 
28     /**
29      * @return an entry that matches exactly [timestamp]
30      * @throws if there is no entry in the trace at [timestamp]
31      */
32     @JsName("getEntryExactlyAt")
33     fun getEntryExactlyAt(timestamp: Timestamp): Entry {
34         return entries.firstOrNull { it.timestamp == timestamp }
35             ?: throw RuntimeException("Entry does not exist for timestamp $timestamp")
36     }
37 
38     /**
39      * @return the entry that is "active' at [timestamp]
40      *
41      * ```
42      *         (the entry at [timestamp] or the one before it if no entry exists at [timestamp])
43      * @throws if
44      * ```
45      *
46      * the provided [timestamp] is before all entries in the trace
47      */
48     @JsName("getEntryAt")
getEntryAtnull49     fun getEntryAt(timestamp: Timestamp): Entry {
50         return entries.dropLastWhile { it.timestamp > timestamp }.lastOrNull()
51             ?: error("No entry at or before timestamp $timestamp")
52     }
53 }
54