Cargo Features
gix-features has no features set by default.
[dependencies]
gix-features = { version = "0.42.1", features = ["progress", "progress-unit-human-numbers", "progress-unit-bytes", "fs-read-dir", "tracing", "tracing-detail", "parallel", "once_cell", "walkdir", "io-pipe", "crc32", "zlib", "zlib-ng", "zlib-rs", "zlib-rust-backend", "cache-efficiency-debug", "document-features"] }
- progress = prodash
-
Provide traits and utilities for providing progress information. These can then be rendered using facilities of the
prodash
crate.Affects
gix-features::progress
… - progress-unit-human-numbers
-
Provide human-readable numbers as well as easier to read byte units for progress bars.
Enables unit-human of optional prodash
progress
Affects
progress::count_with_decimals
… - progress-unit-bytes
-
Provide human readable byte units for progress bars.
Enables bytesize, unit-bytes of optional prodash
Affects
progress::bytes
… - fs-read-dir
-
Provide utilities suitable for working with the
std::fs::read_dir()
.Enables gix-utils
- tracing
-
Implement
tracing
withtracing-core
, which provides applications with valuable performance details if they opt-in to it.Note that this may have overhead as well, thus instrumentations should be used stategically, only providing coarse tracing by default and adding details only where needed while marking them with the appropriate level.
- tracing-detail
-
If enabled, detailed tracing is also emitted, which can greatly increase insights but at a cost.
Enables tracing-detail of gix-trace
- parallel
-
Use scoped threads and channels to parallelize common workloads on multiple objects. If enabled, it is used everywhere where it makes sense. As caches are likely to be used and instantiated per thread, more memory will be used on top of the costs for threads. The
threading
module will contain thread-safe primitives for shared ownership and mutation, otherwise these will be their single threaded counterparts. This way, single-threaded applications don't have to pay for threaded primitives.Enables crossbeam-channel and parking_lot
crossbeam-channel:
'parallel' feature
Affects
parallel::optimize_chunk_size_and_thread_limit
,parallel::num_threads
,parallel::in_parallel_if
… - once_cell
-
If enabled, OnceCell will be made available for interior mutability either in sync or unsync forms.
Enables once_cell
- walkdir
-
Makes facilities of the
walkdir
crate partially available. In conjunction with the parallel feature, directory walking will be parallel instead behind a compatible interface.Enables walkdir
used when parallel is off
gix-path:
for walkdir
Affects
fs::walkdir
… - io-pipe
-
- an in-memory unidirectional pipe using
bytes
as efficient transfer mechanism.
Enables bytes
pipe
Affects
io::pipe
,gix-features::io
… - an in-memory unidirectional pipe using
- crc32
-
provide a proven and fast
crc32
implementation.Enables crc32fast
hashing
Affects
hash::crc32_update
,hash::crc32
… - zlib zlib-ng? zlib-ng-compat? zlib-rs? zlib-rust-backend? zlib-stock?
-
Enable the usage of zlib-related utilities to compress or decompress data. This enables the
flate2
crate, and always uses the high-performancezlib-rs
backend. Note that the various past features for selecting zlib backends are now deprecated and do nothing.flate2:
zlib module
Affects
gix-features::zlib
… - zlib-ng = zlib
-
Deprecated: gix always uses zlib-rs.
- zlib-rs = zlib
-
Deprecated: gix always uses zlib-rs now. As of zlib-rs 0.5.0 (used by flate2
1.1.1), this no longer exports C symbols # by default, so it doesn't
conflict with any other zlib library that might be loaded into the same address space. - zlib-ng-compat zlib-stock zlib-rust-backend = zlib
-
Deprecated: gix always uses zlib-rs.
- cache-efficiency-debug
-
Other
Count cache hits and misses and print that debug information on drop. Caches implement this by default, which costs nothing unless this feature is enabled
Features from optional dependencies
In crates that don't use the dep:
syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.
- prodash progress?
- document-features implicit feature
-
Enables document-features
document-features:
Extract documentation for the feature flags from comments in Cargo.toml