git/
lib.rs

1// LINT-REPLACE-START
2// This section is autogenerated, do not modify directly
3// nightly sometimes removes/renames lints
4#![cfg_attr(allow_unknown_lints, allow(unknown_lints))]
5#![cfg_attr(allow_unknown_lints, allow(renamed_and_removed_lints))]
6// enable all rustc's built-in lints
7#![deny(
8	future_incompatible,
9	nonstandard_style,
10	rust_2018_compatibility,
11	rust_2018_idioms,
12	rust_2021_compatibility,
13	unused,
14	warnings
15)]
16// rustc's additional allowed by default lints
17#![deny(
18	absolute_paths_not_starting_with_crate,
19	deprecated_in_future,
20	elided_lifetimes_in_paths,
21	explicit_outlives_requirements,
22	ffi_unwind_calls,
23	keyword_idents,
24	let_underscore_drop,
25	macro_use_extern_crate,
26	meta_variable_misuse,
27	missing_abi,
28	missing_copy_implementations,
29	missing_debug_implementations,
30	missing_docs,
31	non_ascii_idents,
32	noop_method_call,
33	pointer_structural_match,
34	rust_2021_incompatible_closure_captures,
35	rust_2021_incompatible_or_patterns,
36	rust_2021_prefixes_incompatible_syntax,
37	rust_2021_prelude_collisions,
38	single_use_lifetimes,
39	trivial_casts,
40	trivial_numeric_casts,
41	unreachable_pub,
42	unsafe_code,
43	unsafe_op_in_unsafe_fn,
44	unused_crate_dependencies,
45	unused_extern_crates,
46	unused_import_braces,
47	unused_lifetimes,
48	unused_macro_rules,
49	unused_qualifications,
50	unused_results,
51	unused_tuple_struct_fields,
52	variant_size_differences
53)]
54// enable all of Clippy's lints
55#![deny(clippy::all, clippy::cargo, clippy::pedantic, clippy::restriction)]
56#![cfg_attr(include_nightly_lints, deny(clippy::nursery))]
57#![allow(
58	clippy::arithmetic_side_effects,
59	clippy::arithmetic_side_effects,
60	clippy::blanket_clippy_restriction_lints,
61	clippy::bool_to_int_with_if,
62	clippy::default_numeric_fallback,
63	clippy::else_if_without_else,
64	clippy::expect_used,
65	clippy::float_arithmetic,
66	clippy::implicit_return,
67	clippy::indexing_slicing,
68	clippy::map_err_ignore,
69	clippy::missing_docs_in_private_items,
70	clippy::missing_trait_methods,
71	clippy::mod_module_files,
72	clippy::module_name_repetitions,
73	clippy::new_without_default,
74	clippy::non_ascii_literal,
75	clippy::option_if_let_else,
76	clippy::pub_use,
77	clippy::question_mark_used,
78	clippy::redundant_pub_crate,
79	clippy::ref_patterns,
80	clippy::std_instead_of_alloc,
81	clippy::std_instead_of_core,
82	clippy::tabs_in_doc_comments,
83	clippy::tests_outside_test_module,
84	clippy::too_many_lines,
85	clippy::unwrap_used
86)]
87#![deny(
88	rustdoc::bare_urls,
89	rustdoc::broken_intra_doc_links,
90	rustdoc::invalid_codeblock_attributes,
91	rustdoc::invalid_html_tags,
92	rustdoc::missing_crate_level_docs,
93	rustdoc::private_doc_tests,
94	rustdoc::private_intra_doc_links
95)]
96// allow some things in tests
97#![cfg_attr(
98	test,
99	allow(
100		let_underscore_drop,
101		clippy::cognitive_complexity,
102		clippy::let_underscore_must_use,
103		clippy::let_underscore_untyped,
104		clippy::needless_pass_by_value,
105		clippy::panic,
106		clippy::shadow_reuse,
107		clippy::shadow_unrelated,
108		clippy::undocumented_unsafe_blocks,
109		clippy::unimplemented,
110		clippy::unreachable
111	)
112)]
113// allowable upcoming nightly lints
114#![cfg_attr(
115	include_nightly_lints,
116	allow(
117		clippy::arc_with_non_send_sync,
118		clippy::min_ident_chars,
119		clippy::needless_raw_strings,
120		clippy::pub_with_shorthand,
121		clippy::redundant_closure_call,
122		clippy::single_call_fn
123	)
124)]
125// LINT-REPLACE-END
126
127//! Git Interactive Rebase Tool - Git Module
128//!
129//! # Description
130//! This module is used to handle working with external Git systems.
131//!
132//! ```
133//! use git::Repository;
134//! let repository = Repository::open_from_env().unwrap();
135//!
136//! let config = repository.load_config().unwrap();
137//! let pager = config.get_str("core.pager");
138//! ```
139//!
140//! ## Test Utilities
141//! To facilitate testing the usages of this crate, a set of testing utilities are provided. Since
142//! these utilities are not tested, and often are optimized for developer experience than
143//! performance, they should only be used in test code.
144
145mod commit;
146mod commit_diff;
147mod commit_diff_loader;
148mod commit_diff_loader_options;
149mod delta;
150mod diff_line;
151pub mod errors;
152mod file_mode;
153mod file_status;
154mod file_status_builder;
155mod origin;
156mod reference;
157mod reference_kind;
158mod repository;
159mod status;
160pub mod testutil;
161mod user;
162
163pub use git2::{Config, ErrorCode};
164
165pub use crate::{
166	commit::Commit,
167	commit_diff::CommitDiff,
168	commit_diff_loader_options::CommitDiffLoaderOptions,
169	delta::Delta,
170	diff_line::DiffLine,
171	file_mode::FileMode,
172	file_status::FileStatus,
173	origin::Origin,
174	reference::Reference,
175	reference_kind::ReferenceKind,
176	repository::Repository,
177	status::Status,
178	user::User,
179};