Skip to content

Commit 9ec05f6

Browse files
dtolnaydtolnay
committed
Use differently named __private module per patch release
1 parent d2c492b commit 9ec05f6

File tree

7 files changed

+76
-47
lines changed

7 files changed

+76
-47
lines changed

‎build.rs‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,30 @@ use std::ffi::OsString;
33
use std::fs;
44
use std::io::ErrorKind;
55
use std::iter;
6-
use std::path::Path;
6+
use std::path::{Path, PathBuf};
77
use std::process::{self, Command, Stdio};
88
use std::str;
99

10+
const PRIVATE: &str = "\
11+
#[doc(hidden)]
12+
pub mod __private$$ {
13+
#[doc(hidden)]
14+
pub use crate::private::*;
15+
}
16+
";
17+
1018
fn main() {
1119
println!("cargo:rerun-if-changed=build/probe.rs");
1220

1321
println!("cargo:rustc-check-cfg=cfg(error_generic_member_access)");
1422
println!("cargo:rustc-check-cfg=cfg(thiserror_nightly_testing)");
1523
println!("cargo:rustc-check-cfg=cfg(thiserror_no_backtrace_type)");
1624

25+
let out_dir = PathBuf::from(env::var_os("OUT_DIR").unwrap());
26+
let patch_version = env::var("CARGO_PKG_VERSION_PATCH").unwrap();
27+
let module = PRIVATE.replace("$$", &patch_version);
28+
fs::write(out_dir.join("private.rs"), module).unwrap();
29+
1730
let error_generic_member_access;
1831
let consider_rustc_bootstrap;
1932
if compile_probe(false) {

‎impl/src/expand.rs‎

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ use crate::ast::{Enum, Field, Input, Struct};
22
use crate::attr::Trait;
33
use crate::fallback;
44
use crate::generics::InferredBounds;
5+
use crate::private;
56
use crate::unraw::MemberUnraw;
67
use proc_macro2::{Ident, Span, TokenStream};
78
use quote::{format_ident, quote, quote_spanned, ToTokens};
@@ -35,17 +36,17 @@ fn impl_struct(input: Struct) -> TokenStream {
3536
let source_body = if let Some(transparent_attr) = &input.attrs.transparent {
3637
let only_field = &input.fields[0];
3738
if only_field.contains_generic {
38-
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::__private::Error));
39+
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::#private::Error));
3940
}
4041
let member = &only_field.member;
4142
Some(quote_spanned! {transparent_attr.span=>
42-
::thiserror::__private::Error::source(self.#member.as_dyn_error())
43+
::thiserror::#private::Error::source(self.#member.as_dyn_error())
4344
})
4445
} else if let Some(source_field) = input.source_field() {
4546
let source = &source_field.member;
4647
if source_field.contains_generic {
4748
let ty = unoptional_type(source_field.ty);
48-
error_inferred_bounds.insert(ty, quote!(::thiserror::__private::Error + 'static));
49+
error_inferred_bounds.insert(ty, quote!(::thiserror::#private::Error + 'static));
4950
}
5051
let asref = if type_is_option(source_field.ty) {
5152
Some(quote_spanned!(source.span()=> .as_ref()?))
@@ -63,8 +64,8 @@ fn impl_struct(input: Struct) -> TokenStream {
6364
};
6465
let source_method = source_body.map(|body| {
6566
quote! {
66-
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::__private::Error + 'static)> {
67-
use ::thiserror::__private::AsDynError as _;
67+
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::#private::Error + 'static)> {
68+
use ::thiserror::#private::AsDynError as _;
6869
#body
6970
}
7071
}
@@ -91,28 +92,28 @@ fn impl_struct(input: Struct) -> TokenStream {
9192
} else if type_is_option(backtrace_field.ty) {
9293
Some(quote! {
9394
if let ::core::option::Option::Some(backtrace) = &self.#backtrace {
94-
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
95+
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
9596
}
9697
})
9798
} else {
9899
Some(quote! {
99-
#request.provide_ref::<::thiserror::__private::Backtrace>(&self.#backtrace);
100+
#request.provide_ref::<::thiserror::#private::Backtrace>(&self.#backtrace);
100101
})
101102
};
102103
quote! {
103-
use ::thiserror::__private::ThiserrorProvide as _;
104+
use ::thiserror::#private::ThiserrorProvide as _;
104105
#source_provide
105106
#self_provide
106107
}
107108
} else if type_is_option(backtrace_field.ty) {
108109
quote! {
109110
if let ::core::option::Option::Some(backtrace) = &self.#backtrace {
110-
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
111+
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
111112
}
112113
}
113114
} else {
114115
quote! {
115-
#request.provide_ref::<::thiserror::__private::Backtrace>(&self.#backtrace);
116+
#request.provide_ref::<::thiserror::#private::Backtrace>(&self.#backtrace);
116117
}
117118
};
118119
quote! {
@@ -201,7 +202,7 @@ fn impl_struct(input: Struct) -> TokenStream {
201202
quote! {
202203
#[allow(unused_qualifications)]
203204
#[automatically_derived]
204-
impl #impl_generics ::thiserror::__private::Error for #ty #ty_generics #error_where_clause {
205+
impl #impl_generics ::thiserror::#private::Error for #ty #ty_generics #error_where_clause {
205206
#source_method
206207
#provide_method
207208
}
@@ -221,11 +222,11 @@ fn impl_enum(input: Enum) -> TokenStream {
221222
if let Some(transparent_attr) = &variant.attrs.transparent {
222223
let only_field = &variant.fields[0];
223224
if only_field.contains_generic {
224-
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::__private::Error));
225+
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::#private::Error));
225226
}
226227
let member = &only_field.member;
227228
let source = quote_spanned! {transparent_attr.span=>
228-
::thiserror::__private::Error::source(transparent.as_dyn_error())
229+
::thiserror::#private::Error::source(transparent.as_dyn_error())
229230
};
230231
quote! {
231232
#ty::#ident {#member: transparent} => #source,
@@ -234,7 +235,7 @@ fn impl_enum(input: Enum) -> TokenStream {
234235
let source = &source_field.member;
235236
if source_field.contains_generic {
236237
let ty = unoptional_type(source_field.ty);
237-
error_inferred_bounds.insert(ty, quote!(::thiserror::__private::Error + 'static));
238+
error_inferred_bounds.insert(ty, quote!(::thiserror::#private::Error + 'static));
238239
}
239240
let asref = if type_is_option(source_field.ty) {
240241
Some(quote_spanned!(source.span()=> .as_ref()?))
@@ -255,8 +256,8 @@ fn impl_enum(input: Enum) -> TokenStream {
255256
}
256257
});
257258
Some(quote! {
258-
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::__private::Error + 'static)> {
259-
use ::thiserror::__private::AsDynError as _;
259+
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::#private::Error + 'static)> {
260+
use ::thiserror::#private::AsDynError as _;
260261
#[allow(deprecated)]
261262
match self {
262263
#(#arms)*
@@ -292,12 +293,12 @@ fn impl_enum(input: Enum) -> TokenStream {
292293
let self_provide = if type_is_option(backtrace_field.ty) {
293294
quote! {
294295
if let ::core::option::Option::Some(backtrace) = backtrace {
295-
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
296+
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
296297
}
297298
}
298299
} else {
299300
quote! {
300-
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
301+
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
301302
}
302303
};
303304
quote! {
@@ -306,7 +307,7 @@ fn impl_enum(input: Enum) -> TokenStream {
306307
#source: #varsource,
307308
..
308309
} => {
309-
use ::thiserror::__private::ThiserrorProvide as _;
310+
use ::thiserror::#private::ThiserrorProvide as _;
310311
#source_provide
311312
#self_provide
312313
}
@@ -330,7 +331,7 @@ fn impl_enum(input: Enum) -> TokenStream {
330331
};
331332
quote! {
332333
#ty::#ident {#backtrace: #varsource, ..} => {
333-
use ::thiserror::__private::ThiserrorProvide as _;
334+
use ::thiserror::#private::ThiserrorProvide as _;
334335
#source_provide
335336
}
336337
}
@@ -340,12 +341,12 @@ fn impl_enum(input: Enum) -> TokenStream {
340341
let body = if type_is_option(backtrace_field.ty) {
341342
quote! {
342343
if let ::core::option::Option::Some(backtrace) = backtrace {
343-
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
344+
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
344345
}
345346
}
346347
} else {
347348
quote! {
348-
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
349+
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
349350
}
350351
};
351352
quote! {
@@ -476,7 +477,7 @@ fn impl_enum(input: Enum) -> TokenStream {
476477
quote! {
477478
#[allow(unused_qualifications)]
478479
#[automatically_derived]
479-
impl #impl_generics ::thiserror::__private::Error for #ty #ty_generics #error_where_clause {
480+
impl #impl_generics ::thiserror::#private::Error for #ty #ty_generics #error_where_clause {
480481
#source_method
481482
#provide_method
482483
}
@@ -511,7 +512,7 @@ fn fields_pat(fields: &[Field]) -> TokenStream {
511512
fn use_as_display(needs_as_display: bool) -> Option<TokenStream> {
512513
if needs_as_display {
513514
Some(quote! {
514-
use ::thiserror::__private::AsDisplay as _;
515+
use ::thiserror::#private::AsDisplay as _;
515516
})
516517
} else {
517518
None
@@ -533,11 +534,11 @@ fn from_initializer(
533534
let backtrace_member = &backtrace_field.member;
534535
if type_is_option(backtrace_field.ty) {
535536
quote! {
536-
#backtrace_member: ::core::option::Option::Some(::thiserror::__private::Backtrace::capture()),
537+
#backtrace_member: ::core::option::Option::Some(::thiserror::#private::Backtrace::capture()),
537538
}
538539
} else {
539540
quote! {
540-
#backtrace_member: ::core::convert::From::from(::thiserror::__private::Backtrace::capture()),
541+
#backtrace_member: ::core::convert::From::from(::thiserror::#private::Backtrace::capture()),
541542
}
542543
}
543544
});

‎impl/src/fallback.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
use crate::expand::call_site_ident;
2+
use crate::private;
23
use proc_macro2::TokenStream;
34
use quote::quote;
45
use syn::DeriveInput;
@@ -14,7 +15,7 @@ pub(crate) fn expand(input: &DeriveInput, error: syn::Error) -> TokenStream {
1415

1516
#[allow(unused_qualifications)]
1617
#[automatically_derived]
17-
impl #impl_generics ::thiserror::__private::Error for #ty #ty_generics #where_clause
18+
impl #impl_generics ::thiserror::#private::Error for #ty #ty_generics #where_clause
1819
where
1920
// Work around trivial bounds being unstable.
2021
// https://github.com/rust-lang/rust/issues/48214

‎impl/src/fmt.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use crate::ast::{ContainerKind, Field};
22
use crate::attr::{Display, Trait};
3+
use crate::private;
34
use crate::scan_expr::scan_expr;
45
use crate::unraw::{IdentUnraw, MemberUnraw};
56
use proc_macro2::{Delimiter, TokenStream, TokenTree};
@@ -145,7 +146,7 @@ impl Display<'_> {
145146
let wrapped_binding_value = if bonus_display {
146147
quote_spanned!(span=> #binding_value.as_display())
147148
} else if bound == Trait::Pointer {
148-
quote!(::thiserror::__private::Var(#binding_value))
149+
quote!(::thiserror::#private::Var(#binding_value))
149150
} else {
150151
binding_value.into_token_stream()
151152
};

‎impl/src/lib.rs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,24 @@ mod unraw;
3131
mod valid;
3232

3333
use proc_macro::TokenStream;
34+
use proc_macro2::{Ident, Span};
35+
use quote::{ToTokens, TokenStreamExt as _};
3436
use syn::{parse_macro_input, DeriveInput};
3537

3638
#[proc_macro_derive(Error, attributes(backtrace, error, from, source))]
3739
pub fn derive_error(input: TokenStream) -> TokenStream {
3840
let input = parse_macro_input!(input as DeriveInput);
3941
expand::derive(&input).into()
4042
}
43+
44+
#[allow(non_camel_case_types)]
45+
struct private;
46+
47+
impl ToTokens for private {
48+
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
49+
tokens.append(Ident::new(
50+
concat!("__private", env!("CARGO_PKG_VERSION_PATCH")),
51+
Span::call_site(),
52+
));
53+
}
54+
}

‎src/lib.rs‎

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -286,21 +286,6 @@ mod var;
286286

287287
pub use thiserror_impl::*;
288288

289-
// Not public API.
290-
#[doc(hidden)]
291-
pub mod __private {
292-
#[doc(hidden)]
293-
pub use crate::aserror::AsDynError;
294-
#[doc(hidden)]
295-
pub use crate::display::AsDisplay;
296-
#[cfg(error_generic_member_access)]
297-
#[doc(hidden)]
298-
pub use crate::provide::ThiserrorProvide;
299-
#[doc(hidden)]
300-
pub use crate::var::Var;
301-
#[doc(hidden)]
302-
pub use core::error::Error;
303-
#[cfg(all(feature = "std", not(thiserror_no_backtrace_type)))]
304-
#[doc(hidden)]
305-
pub use std::backtrace::Backtrace;
306-
}
289+
mod private;
290+
291+
include!(concat!(env!("OUT_DIR"), "/private.rs"));

‎src/private.rs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#[doc(hidden)]
2+
pub use crate::aserror::AsDynError;
3+
#[doc(hidden)]
4+
pub use crate::display::AsDisplay;
5+
#[cfg(error_generic_member_access)]
6+
#[doc(hidden)]
7+
pub use crate::provide::ThiserrorProvide;
8+
#[doc(hidden)]
9+
pub use crate::var::Var;
10+
#[doc(hidden)]
11+
pub use core::error::Error;
12+
#[cfg(all(feature = "std", not(thiserror_no_backtrace_type)))]
13+
#[doc(hidden)]
14+
pub use std::backtrace::Backtrace;

0 commit comments

Comments
 (0)