timeout-iterator 1.0.0

TimeoutIterator is a wrapper over any iterator that adds peek_timeout and next_timeout functions. The canonical use-case is parsing multi-line free-form records (such as tailing a log fime) where it is desirable to consume the very last line, and peek whether the record continues on the next time, but not block indefinitely on the peek.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

[dependencies.futures]
optional = true
version = "0.3.8"

[dependencies.futures-util]
optional = true
version = "0.3.8"

[dependencies.tokio]
features = ["rt-multi-thread", "macros", "time", "io-util", "stream", "sync"]
optional = true
version = "0.3.6"
[dev-dependencies.assert_matches]
version = "1.4.0"

[dev-dependencies.tokio-test]
version = "0.3.0"

[features]
async = ["futures", "futures-util", "tokio"]

[package]
authors = ["Archis Gore <archis@polyverse.io>"]
categories = ["asynchronous", "caching", "rust-patterns"]
description = "TimeoutIterator is a wrapper over any iterator that adds peek_timeout and next_timeout functions.\nThe canonical use-case is parsing multi-line free-form records (such as tailing a log fime) where it is desirable to\nconsume the very last line, and peek whether the record continues on the next time, but not block\nindefinitely on the peek."
edition = "2018"
keywords = ["iterator", "wrapper", "timeout", "peek", "buffer"]
license-file = "LICENSE"
name = "timeout-iterator"
readme = "README.md"
repository = "https://github.com/polyverse/timeout-iterator"
version = "1.0.0"