vergen_lib/
lib.rs

1// Copyright (c) 2022 vergen developers
2//
3// Licensed under the Apache License, Version 2.0
4// <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0> or the MIT
5// license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
6// option. All files in the project carrying such notice may not be copied,
7// modified, or distributed except according to those terms.
8
9//! # vergen-lib - Common structs, enums and constants used to support [`vergen`](https://docs.rs/vergen)
10//!
11
12// rustc lints
13#![cfg_attr(
14    all(feature = "unstable", nightly),
15    feature(
16        multiple_supertrait_upcastable,
17        must_not_suspend,
18        non_exhaustive_omitted_patterns_lint,
19        strict_provenance_lints,
20        unqualified_local_imports,
21    )
22)]
23#![cfg_attr(nightly, allow(single_use_lifetimes, unexpected_cfgs))]
24#![cfg_attr(
25    nightly,
26    deny(
27        absolute_paths_not_starting_with_crate,
28        ambiguous_glob_imports,
29        ambiguous_glob_reexports,
30        ambiguous_negative_literals,
31        ambiguous_wide_pointer_comparisons,
32        anonymous_parameters,
33        array_into_iter,
34        asm_sub_register,
35        async_fn_in_trait,
36        bad_asm_style,
37        bare_trait_objects,
38        boxed_slice_into_iter,
39        break_with_label_and_loop,
40        clashing_extern_declarations,
41        closure_returning_async_block,
42        coherence_leak_check,
43        confusable_idents,
44        const_evaluatable_unchecked,
45        const_item_mutation,
46        dangling_pointers_from_temporaries,
47        dead_code,
48        dependency_on_unit_never_type_fallback,
49        deprecated,
50        deprecated_in_future,
51        deprecated_safe_2024,
52        deprecated_where_clause_location,
53        deref_into_dyn_supertrait,
54        deref_nullptr,
55        double_negations,
56        drop_bounds,
57        dropping_copy_types,
58        dropping_references,
59        duplicate_macro_attributes,
60        dyn_drop,
61        edition_2024_expr_fragment_specifier,
62        elided_lifetimes_in_paths,
63        ellipsis_inclusive_range_patterns,
64        explicit_outlives_requirements,
65        exported_private_dependencies,
66        ffi_unwind_calls,
67        forbidden_lint_groups,
68        forgetting_copy_types,
69        forgetting_references,
70        for_loops_over_fallibles,
71        function_item_references,
72        hidden_glob_reexports,
73        if_let_rescope,
74        impl_trait_overcaptures,
75        impl_trait_redundant_captures,
76        improper_ctypes,
77        improper_ctypes_definitions,
78        inline_no_sanitize,
79        internal_features,
80        invalid_from_utf8,
81        invalid_macro_export_arguments,
82        invalid_nan_comparisons,
83        invalid_value,
84        irrefutable_let_patterns,
85        keyword_idents_2018,
86        keyword_idents_2024,
87        large_assignments,
88        late_bound_lifetime_arguments,
89        legacy_derive_helpers,
90        let_underscore_drop,
91        macro_use_extern_crate,
92        map_unit_fn,
93        meta_variable_misuse,
94        mismatched_lifetime_syntaxes,
95        missing_abi,
96        missing_copy_implementations,
97        missing_debug_implementations,
98        missing_docs,
99        missing_unsafe_on_extern,
100        mixed_script_confusables,
101        named_arguments_used_positionally,
102        never_type_fallback_flowing_into_unsafe,
103        no_mangle_generic_items,
104        non_ascii_idents,
105        non_camel_case_types,
106        non_contiguous_range_endpoints,
107        non_fmt_panics,
108        non_local_definitions,
109        non_shorthand_field_patterns,
110        non_snake_case,
111        non_upper_case_globals,
112        noop_method_call,
113        opaque_hidden_inferred_bound,
114        out_of_scope_macro_calls,
115        overlapping_range_endpoints,
116        path_statements,
117        private_bounds,
118        private_interfaces,
119        ptr_to_integer_transmute_in_consts,
120        redundant_imports,
121        redundant_lifetimes,
122        redundant_semicolons,
123        refining_impl_trait_internal,
124        refining_impl_trait_reachable,
125        renamed_and_removed_lints,
126        rust_2021_incompatible_closure_captures,
127        rust_2021_incompatible_or_patterns,
128        rust_2021_prefixes_incompatible_syntax,
129        rust_2021_prelude_collisions,
130        rust_2024_guarded_string_incompatible_syntax,
131        rust_2024_incompatible_pat,
132        rust_2024_prelude_collisions,
133        self_constructor_from_outer_item,
134        semicolon_in_expressions_from_macros,
135        single_use_lifetimes,
136        special_module_name,
137        stable_features,
138        static_mut_refs,
139        suspicious_double_ref_op,
140        tail_expr_drop_order,
141        trivial_bounds,
142        trivial_casts,
143        trivial_numeric_casts,
144        type_alias_bounds,
145        tyvar_behind_raw_pointer,
146        uncommon_codepoints,
147        unconditional_recursion,
148        uncovered_param_in_projection,
149        unexpected_cfgs,
150        unfulfilled_lint_expectations,
151        ungated_async_fn_track_caller,
152        uninhabited_static,
153        unit_bindings,
154        unknown_lints,
155        unknown_or_malformed_diagnostic_attributes,
156        unnameable_test_items,
157        unnameable_types,
158        unpredictable_function_pointer_comparisons,
159        unreachable_code,
160        unreachable_patterns,
161        unreachable_pub,
162        unsafe_attr_outside_unsafe,
163        unsafe_op_in_unsafe_fn,
164        unstable_name_collisions,
165        unstable_syntax_pre_expansion,
166        unused_allocation,
167        unused_assignments,
168        unused_associated_type_bounds,
169        unused_attributes,
170        unused_braces,
171        unused_comparisons,
172        unused_crate_dependencies,
173        unused_doc_comments,
174        unused_extern_crates,
175        unused_features,
176        unused_import_braces,
177        unused_imports,
178        unused_labels,
179        unused_lifetimes,
180        unused_macro_rules,
181        unused_macros,
182        unused_must_use,
183        unused_mut,
184        unused_parens,
185        unused_qualifications,
186        unused_results,
187        unused_unsafe,
188        unused_variables,
189        useless_ptr_null_checks,
190        uses_power_alignment,
191        variant_size_differences,
192        while_true,
193    )
194)]
195// If nightly and unstable, allow `incomplete_features` and `unstable_features`
196#![cfg_attr(
197    all(feature = "unstable", nightly),
198    allow(incomplete_features, unstable_features)
199)]
200// If nightly and not unstable, deny `incomplete_features` and `unstable_features`
201#![cfg_attr(
202    all(not(feature = "unstable"), nightly),
203    deny(incomplete_features, unstable_features)
204)]
205#![cfg_attr(all(not(feature = "emit_and_set"), nightly), deny(unsafe_code))]
206#![cfg_attr(all(feature = "emit_and_set", nightly), allow(unsafe_code))]
207// The unstable lints
208#![cfg_attr(
209    all(feature = "unstable", nightly),
210    deny(
211        fuzzy_provenance_casts,
212        lossy_provenance_casts,
213        multiple_supertrait_upcastable,
214        must_not_suspend,
215        non_exhaustive_omitted_patterns,
216        unqualified_local_imports,
217    )
218)]
219// clippy lints
220#![cfg_attr(nightly, deny(clippy::all, clippy::pedantic))]
221#![cfg_attr(nightly, allow(clippy::ref_option_ref))]
222// rustdoc lints
223#![cfg_attr(
224    nightly,
225    deny(
226        rustdoc::bare_urls,
227        rustdoc::broken_intra_doc_links,
228        rustdoc::invalid_codeblock_attributes,
229        rustdoc::invalid_html_tags,
230        rustdoc::missing_crate_level_docs,
231        rustdoc::private_doc_tests,
232        rustdoc::private_intra_doc_links,
233    )
234)]
235#![cfg_attr(all(docsrs, nightly), feature(doc_cfg))]
236#![cfg_attr(all(nightly, coverage_nightly), feature(coverage_attribute))]
237
238#[cfg(test)]
239use {temp_env as _, test_util as _};
240
241mod config;
242pub mod constants;
243mod emitter;
244mod entries;
245mod keys;
246mod utils;
247
248pub use self::config::Describe;
249pub use self::config::Dirty;
250pub use self::config::Sha;
251pub use self::emitter::Emitter;
252pub use self::entries::Add as AddEntries;
253pub use self::entries::AddCustom as AddCustomEntries;
254pub use self::entries::CargoRerunIfChanged;
255pub use self::entries::CargoRustcEnvMap;
256pub use self::entries::CargoWarning;
257pub use self::entries::DefaultConfig;
258#[doc(hidden)]
259pub use self::entries::test_gen::CustomInsGen;
260pub use self::keys::vergen_key::VergenKey;
261pub use self::utils::add_default_map_entry;
262pub use self::utils::add_map_entry;
263pub use self::utils::count_idempotent;
264#[cfg(feature = "vcs_info")]
265pub use self::utils::vcs_info;
vergen_lib/lib.rs

vergen_lib/
lib.rs
