gix 0.49.1

Interact with git repositories just like git would
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

[package]
name = "gix"
repository = "https://github.com/Byron/gitoxide"
description = "Interact with git repositories just like git would"
license = "MIT/Apache-2.0"
version = "0.49.1"
authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
edition = "2021"
include = ["src/**/*", "LICENSE-*", "CHANGELOG.md"]
rust-version = "1.65"

[lib]
doctest = false
test = true

[[test]]
name = "gix"
path = "tests/gix.rs"
required-features = []

[[test]]
name = "gix-with-regex"
path = "tests/gix-with-regex.rs"
required-features = ["regex"]

[[example]]
name = "clone"
path = "examples/clone.rs"
required-features = ["blocking-network-client"]

[features]

default = ["max-performance-safe", "comfort"]

#! ### Mutually Exclusive Network Client
#! Either `async-*` or `blocking-*` versions of these toggles may be enabled at a time.

## Make `gix-protocol` available along with an async client.
async-network-client = ["gix-protocol/async-client"]
## Use this if your crate uses `async-std` as runtime, and enable basic runtime integration when connecting to remote servers.
async-network-client-async-std = ["async-std", "async-network-client", "gix-transport/async-std"]
## Make `gix-protocol` available along with a blocking client.
blocking-network-client = ["gix-protocol/blocking-client"]
## Stacks with `blocking-network-client` to provide support for HTTP/S using **curl**, and implies blocking networking as a whole.
blocking-http-transport-curl = ["blocking-network-client", "gix-transport/http-client-curl"]
## Stacks with `blocking-network-client` to provide support for HTTP/S using **reqwest**, and implies blocking networking as a whole.
blocking-http-transport-reqwest = ["blocking-network-client", "gix-transport/http-client-reqwest"]
## Stacks with `blocking-http-transport-reqwest` and enables HTTPS via the `rustls` crate. Note that https isn't available without a selection.
blocking-http-transport-reqwest-rust-tls = ["blocking-http-transport-reqwest", "reqwest-for-configuration-only/rustls-tls", "reqwest-for-configuration-only/trust-dns"]
## Stacks with `blocking-http-transport-reqwest` and enables HTTPS via the `native-tls` crate. Note that https isn't available without a selection.
blocking-http-transport-reqwest-native-tls = ["blocking-http-transport-reqwest", "reqwest-for-configuration-only/default-tls" ]


#! ### Other

## Data structures implement `serde::Serialize` and `serde::Deserialize`.
serde = [   "dep:serde",
            "gix-pack/serde",
            "gix-object/serde",
            "gix-protocol?/serde",
            "gix-transport?/serde",
            "gix-ref/serde",
            "gix-odb/serde",
            "gix-index/serde",
            "gix-mailmap/serde",
            "gix-url/serde",
            "gix-attributes/serde",
            "gix-ignore/serde",
            "gix-revision/serde",
            "gix-worktree/serde",
            "gix-commitgraph/serde",
            "gix-credentials/serde"]

## Re-export the progress tree root which allows to obtain progress from various functions which take `impl gix::Progress`.
progress-tree = ["prodash/progress-tree"]

## Various progress-related features that improve the look of progress message units.
comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human-numbers"]

## Print debugging information about usage of object database caches, useful for tuning cache sizes.
cache-efficiency-debug = ["gix-features/cache-efficiency-debug"]

#! ### Performance

## Activate features that maximize performance, like usage of threads, `zlib-ng` and access to caching in object databases, skipping the ones known to cause compile failures
## on some platforms.
max-performance-safe = [
    "gix-features/parallel",
    "pack-cache-lru-static",
    "pack-cache-lru-dynamic",
    "gix-features/fs-walkdir-parallel"
]

## The tempfile registry uses a better implementation of a thread-safe hashmap, relying on an external crate.
## This may be useful when tempfiles are created and accessed in a massively parallel fashion and you know that this is indeed faster than
## the simpler implementation that is the default.
hp-tempfile-registry = ["gix-tempfile/hp-hashmap"]

## Provide a fixed-size allocation-free LRU cache for packs. It's useful if caching is desired while keeping the memory footprint
## for the LRU-cache itself low.
pack-cache-lru-static = ["gix-pack/pack-cache-lru-static"]

## Provide a hash-map based LRU cache whose eviction is based a memory cap calculated from object data.
pack-cache-lru-dynamic = ["gix-pack/pack-cache-lru-dynamic"]

## Activate other features that maximize performance, like usage of threads, `zlib-ng` and access to caching in object databases.
## Note that some platforms might suffer from compile failures, which is when `max-performance-safe` should be used.
max-performance = [ "max-performance-safe", "gix-features/zlib-ng", "fast-sha1" ]

## If enabled, use assembly versions of sha1 on supported platforms.
## This might cause compile failures as well which is why it can be turned off separately.
fast-sha1 = [ "gix-features/fast-sha1" ]


[dependencies]
gix-utils = { version = "^0.1.4", path = "../gix-utils" }
gix-fs = { version = "^0.4.0", path = "../gix-fs" }
gix-ref = { version = "^0.33.0", path = "../gix-ref" }
gix-discover = { version = "^0.22.0", path = "../gix-discover" }
gix-tempfile = { version = "^7.0.0", path = "../gix-tempfile", default-features = false, features = ["signals"] }
gix-lock = { version = "^7.0.0", path = "../gix-lock" }
gix-validate = { version = "^0.7.6", path = "../gix-validate" }
gix-sec = { version = "^0.8.3", path = "../gix-sec" }
gix-date = { version = "^0.7.0", path = "../gix-date" }
gix-refspec = { version = "^0.14.0", path = "../gix-refspec" }
gix-filter = { version = "^0.1.0", path = "../gix-filter" }

gix-config = { version = "^0.26.0", path = "../gix-config" }
gix-odb = { version = "^0.50.0", path = "../gix-odb" }
gix-hash = { version = "^0.11.3", path = "../gix-hash" }
gix-object = { version = "^0.33.0", path = "../gix-object" }
gix-actor = { version = "^0.24.0", path = "../gix-actor" }
gix-pack = { version = "^0.40.0", path = "../gix-pack", features = ["object-cache-dynamic"] }
gix-revision = { version = "^0.18.0", path = "../gix-revision" }
gix-negotiate = { version = "^0.5.0", path = "../gix-negotiate" }

gix-path = { version = "^0.8.3", path = "../gix-path" }
gix-url = { version = "^0.21.0", path = "../gix-url" }
gix-traverse = { version = "^0.30.0", path = "../gix-traverse" }
gix-protocol = { version = "^0.36.0", path = "../gix-protocol", optional = true }
gix-transport = { version = "^0.34.0", path = "../gix-transport", optional = true }
gix-diff = { version = "^0.33.0", path = "../gix-diff" }
gix-mailmap = { version = "^0.16.0", path = "../gix-mailmap" }
gix-features = { version = "^0.32.0", path = "../gix-features", features = ["progress", "once_cell"] }
gix-trace = { version = "^0.1.2", path = "../gix-trace" }

gix-attributes = { version = "^0.15.0", path = "../gix-attributes" }
gix-ignore = { version = "^0.5.0", path = "../gix-ignore" }
gix-glob = { version = "^0.10.0", path = "../gix-glob" }
gix-credentials = { version = "^0.17.0", path = "../gix-credentials" }
gix-prompt = { version = "^0.5.3", path = "../gix-prompt" }
gix-index = { version = "^0.21.0", path = "../gix-index" }
gix-worktree = { version = "^0.22.0", path = "../gix-worktree" }
gix-hashtable = { version = "^0.2.3", path = "../gix-hashtable" }
gix-commitgraph = { version = "^0.18.0", path = "../gix-commitgraph" }

prodash = { version = "25.0", optional = true, default-features = false, features = ["progress-tree"] }
once_cell = "1.14.0"
signal-hook = { version = "0.3.9", default-features = false }
thiserror = "1.0.26"
log = "0.4.14"
serde = { version = "1.0.114", optional = true, default-features = false, features = ["derive"]}
smallvec = "1.9.0"
async-std = { version = "1.12.0", optional = true }

## For use in rev-parse, which provides searching commits by running a regex on their message.
##
## If disabled, the text will be search verbatim in any portion of the commit message, similar to
## how a simple unanchored regex of only 'normal' characters would work.
regex = { version = "1.6.0", optional = true, default-features = false, features = ["std"] }

# For internal use to allow pure-Rust builds without openssl.
reqwest-for-configuration-only = { package = "reqwest", version = "0.11.13", default-features = false, optional = true }

document-features = { version = "0.2.0", optional = true }

[target.'cfg(target_vendor = "apple")'.dependencies]
unicode-normalization = { version = "0.1.19", default-features = false }

[dev-dependencies]
gix-testtools = { path = "../tests/tools" }
is_ci = "1.1.1"
anyhow = "1"
walkdir = "2.3.2"
serial_test = { version = "2.0.0", default-features = false }
async-std = { version = "1.12.0", features = ["attributes"] }

[package.metadata.docs.rs]
features = ["document-features", "max-performance", "blocking-network-client", "blocking-http-transport-curl", "serde"]
rustdoc-args = ["--cfg", "docsrs"]