Reference¶
Exhaustive descriptions of what rtb-forge exposes: what each thing is, what
it defaults to, and what happens when it is wrong.
Which reference page do I need?¶
| Page | Answers |
|---|---|
| Cargo features | Which features exist, which are on by default, what turning one off removes |
| Release source configuration | Every source_type and every parameter key, with defaults and validation errors |
| Release-provider methods and HTTP behaviour | What each trait method requests, and how each backend fills the Release shape |
ProviderError variants |
Every release-provider failure, its diagnostic code, and which HTTP status produces it |
Repo operations |
Every git method, its options struct, and whether it uses gix or the git binary |
RepoError variants |
Every git failure, its diagnostic code, and which method produces it |
| Environment variables and subprocess behaviour | What rtb-forge reads from and sets on the environment, and what it shells out to |
What version does this describe?¶
rtb-forge 0.7.1, the version in this repository. The crate is pre-1.0: the
public surface can change on a minor bump. Every value type and error enum is
#[non_exhaustive], so new fields and variants arrive without a major version.
The generated API reference — signatures, generics, trait bounds — lives at docs.rs/rtb-forge. These pages cover the behaviour docs.rs cannot show you: defaults, validation, HTTP shapes, and failure modes.