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

vergen_lib/
lib.rs
