subms-segment-reader 0.5.0

submillisecond.com cookbook recipe - storage: subms-segment-reader. Read length-prefix framed records from a segment file; surface typed errors on truncation.
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.

[package]
edition = "2024"
rust-version = "1.85"
name = "subms-segment-reader"
version = "0.5.0"
authors = ["Kieran Smith <oss@submillisecond.com>"]
build = false
autolib = false
autobins = false
autoexamples = false
autotests = false
autobenches = false
description = "submillisecond.com cookbook recipe - storage: subms-segment-reader. Read length-prefix framed records from a segment file; surface typed errors on truncation."
homepage = "https://submillisecond.com/cookbook/recipes/subms-segment-reader"
readme = "README.md"
keywords = [
    "segment",
    "log",
    "framing",
    "subms",
]
categories = [
    "filesystem",
    "data-structures",
]
license = "MIT OR Apache-2.0"

[features]
crc32 = ["dep:crc32c"]
default = []
harness = ["dep:subms"]
lz4 = ["dep:lz4_flex"]
mmap = ["dep:memmap2"]
seek-index = []
wal-cursor = []
xxh3 = ["dep:xxhash-rust"]

[lib]
name = "subms_segment_reader"
path = "src/lib.rs"

[[example]]
name = "perf_features"
path = "examples/perf_features.rs"
required-features = [
    "harness",
    "mmap",
    "crc32",
    "xxh3",
    "lz4",
    "seek-index",
    "wal-cursor",
]

[[example]]
name = "perf_main"
path = "examples/perf_main.rs"
required-features = ["harness"]

[[test]]
name = "segment_tests"
path = "tests/segment_tests.rs"

[[test]]
name = "sub_millisecond_bench"
path = "tests/sub_millisecond_bench.rs"

[dependencies.crc32c]
version = "0.6"
optional = true

[dependencies.lz4_flex]
version = "0.11"
features = [
    "std",
    "safe-encode",
    "safe-decode",
]
optional = true
default-features = false

[dependencies.memmap2]
version = "0.9"
optional = true

[dependencies.subms]
version = "0.5.0"
optional = true

[dependencies.xxhash-rust]
version = "0.8"
features = ["xxh3"]
optional = true