cargo-tarpaulin 0.32.2

Cargo-Tarpaulin is a tool to determine code coverage achieved via tests
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

[test_config]
# The name of the project or the configuration.
name = "tarpaulin"

# Path to the project's cargo manifest.
# The manifest path is required for Tarpaulin to find the project.
manifest-path = "./Cargo.toml"

# Optional path to a custom tarpaulin.toml config file.
# config = null

# Path to the project's root directory.
# This is optional and can be used to override the default location.
# root = null

# Flag to run tests with the ignored attribute.
# If true, ignored tests will be included in the coverage report.
run-ignored = false

# Ignore panic macros in code during coverage analysis.
ignore-panics = false

# Force a clean step before building the project.
# This will clean the target directory before running tests.
force-clean = false

# Skip the clean step and proceed without cleaning the target directory.
skip-clean = true

# Enable verbose logging for user information during tests.
verbose = true

# Enable debugging information for internal issues.
debug = false

# Enable the event logger for trace dumps.
dump-traces = false

# Count hits for coverage, useful for more detailed reporting.
count = true

# Set the type of coverage to be run:
# - 'line' for line coverage (default)
# - 'branch' for branch coverage
line-coverage = true
branch-coverage = false

# Directory to output coverage files and reports.
output-dir = "./coverage_output"

# Optional key for a coveralls service or repository.
# coveralls = null

# Specify the CI server tool for integration with coverage reports.
# Only valid if coveralls is set.
# ci-tool = null

# Report URI to send results to a custom endpoint if provided.
# report-uri = null

# Forward unexpected signals back to the tracee (useful for tests relying on signals).
forward-signals = false

# Flag to disable linking with `-Clink-dead-code`.
no-dead-code = false

# Include all available features in the build.
all-features = false

# Exclude default features from the build.
no-default-features = false

# Build all packages in the workspace.
workspace = false

# Timeout duration for tests to finish.
# (in a format that human-time library can parse, e.g., "5m" for 5 minutes)
test-timeout = "10m"

# Build in release mode for optimized builds.
release = false

# Do not run the tests, only build them (for faster compilation).
no-run = false

# Do not update the `Cargo.lock` file.
locked = false

# Do not update the `Cargo.lock` or any caches.
frozen = false

# Build for a specific target architecture or OS.
# target = null

# Directory for storing generated build artifacts.
target-dir = "./target"

# Run the tests without accessing the network (offline mode).
offline = false

# Cargo subcommand to run; options are "Test" or "Build".
command = "Test"

# Types of tests to collect coverage for. For example: ["Lib", "AllTargets", "Benchmarks", "Bins", "Examples", "Doctests", "Tests"]
run-types = ["AllTargets"]

# List of packages to include when building the target project.
packages = []

# List of packages to exclude from testing.
exclude = []

# List of file paths to exclude from testing.
exclude-files = []

# List of file paths to include (and exclude all others) from testing.
include-files = []

# Additional arguments to pass to the test executables.
args = []

# Features to include in the build, e.g., "feature1 feature2".
# features = null

# List of unstable cargo features to use.
unstable-features = []

# Output files to generate as part of the test execution.
generate = []

# List of test names to run (corresponding to `cargo --test <NAME>`).
test-names = []

# List of binary names to run (corresponding to `cargo --bin <NAME>`).
bin-names = []

# List of example names to run (corresponding to `cargo --example <NAME>`).
example-names = []

# List of bench names to run (corresponding to `cargo --bench <NAME>`).
bench-names = []

# Flag to allow the process to stop immediately on a test failure.
no-fail-fast = false

# Specify a custom profile to use when building.
# profile = null

# Fail if coverage is below the specified threshold (e.g., 80.0).
# fail-under = null

# Metadata generated from `cargo metadata` (this field is internal and usually empty).
# metadata = null

# Flag to avoid passing `--cfg=tarpaulin` to the Rust compiler.
avoid-cfg-tarpaulin = false

# Colouring of logs in the terminal output (e.g., "auto", "always", "never").
color = "Auto"

# Follow traced executables down through function calls.
follow-exec = true

# Number of jobs (threads) to use for building the tests.
# jobs = null

# Allow the test suite to use implicit test threads if needed.
implicit-test-threads = true

# Specify the engine to use for collecting coverage (default: "trace").
engine = "Llvm"

# Additional rust flags to be passed during the build process.
# rustflags = null

# Include test functions in the coverage statistics.
include-tests = true

# Delay after tests to collect instrumentation files (LLVM only).
# post-test-delay = 0

# Additional objects to be included in the coverage instrumentation.
objects = []

# Directory where profraw files are stored.
profraw-folder = "./target/profraw"

# Fail immediately after a single test fails.
fail-immediately = false

# Log to stderr instead of the default output.
stderr = false