Flutter时间戳队列管理插件timestampedqueue的使用

Flutter时间戳队列管理插件timestampedqueue的使用

该插件实现了一个类来管理一个队列，并将时间戳与队列中的条目关联起来，以便可以计算两个条目之间的时间间隔。它可以用类似列表的方式使用：获取最后一个元素、切片等。此外，还可以搜索序列以检查它们是否在一段时间内完成。

特性

• TimestampedQueue 类是抽象的，因此可以使用任何类型的元素。
• 时间戳是一个整数值。虽然它是为时间戳设计的（例如 DateTime.now().millisecondsSinceEpoch），但也可以使用任何用户定义的整数值。该包附带了两个基本的时间函数：LegacyTimeFunction.microsecondsNow 和 LegacyTimeFunction.millisecondsNow。默认的是 LegacyTimeFunction.microsecondsNow。
• 如果队列可能变得太大，可以只保留定义数量的值。

开始使用

要开始使用此插件，请将其添加到您的 pubspec.yaml 文件中：

dependencies:
    timestampedqueue:

然后获取依赖项（例如 dart pub get 或 flutter pub get）并在应用程序中导入：

import 'package:timestampedqueue/timestampedqueue.dart';

使用示例

基本用法如下：

const TimestampedQueue<int> queue = TimestampedQueue();

[1,3,5,1,3,5,1,5,8,5].forEach((element) {
    queue.add(element);
    sleep(Duration(milliseconds: 5));
});

之后，可以搜索序列或检查最后完成的序列是否为特定序列：

print(queue.sequenceFind([1,5], timeDone: 10));
print(queue.lastSequenceDone([1,5,8,5]));
print(queue);
print(queue.slice(1, 4));

额外信息

代码已记录文档，如果想要生成完整的文档，可以在源文件夹中执行 dart doc . 命令。

TimestampedQueue 类的主要方法如下：

• void add(dynamic entry, [int? time]) 添加新的值 entry 到队列，并设置其时间戳为 time。如果 time 设置为 null，则值将被设置为当前时间（毫秒）。

• int? find(T? item, {int offset = 0, bool matchNull = false}) 查找队列中第一个出现的 item 的位置。

• bool isSequenceAt(List<T?> sequence, int position, {int? timeDone, bool matchNull = false}) 如果序列在 position 出现且从第一个条目到最后一个条目的时间差小于 timeDone 毫秒，则返回 true。

• bool lastSequenceDone(List<T?> sequence, {int? timeDone, bool matchNull = false}) 如果最后完成的序列是 sequence，并且从第一个条目到最后一个条目的时间差小于等于 timeDone，则返回 true。

• int? reverseFind(T? item, {int offset = 0, bool matchNull = false}) 查找队列中最后一个出现的 item 的位置。

• int? sequenceFind(List<T?> sequence, {int? timeDone, int offset = 0, bool matchNull = false}) 返回序列首次出现的位置，且从序列开始到结束的时间差小于等于 timeDone。如果序列未出现或出现时间大于请求时间，则函数返回 null。

• int? sequenceReverseFind(List<T?> sequence, {int? timeDone, int? offset, bool matchNull = false}) 返回序列最后一次出现的位置，且从序列开始到结束的时间差小于等于 timeDone。如果序列未出现或出现时间大于请求时间，则函数返回 null。

• TimestampedQueue<T> slice(int start, [int? end]) 返回一个队列的切片对象，包含从 start 到 end（包括两端）的对象。复制是浅拷贝（即条目不会被克隆）。

示例代码

以下是一个完整的示例代码：

import 'dart:io';
import 'package:timestampedqueue/timestampedqueue.dart';

void main() {
  TimestampedQueue<int> queue = TimestampedQueue()..add(0);

  for (var element in [1,3,5,1,3,5,1,5,8,5]) {
    queue.add(element);
    sleep(Duration(milliseconds: 5));
  }

  print(queue.sequenceFind([1,5], timeDone: 10));
  print(queue.lastSequenceDone([1,5,8,5]));
  print(queue);
  print(queue.slice(1, 4));
}