Skip to content

Use differently named __private module per patch release #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dtolnay merged 1 commit into from
Sep 28, 2025
+76 −47
Merged

Use differently named __private module per patch release #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,30 @@ use std::ffi::OsString;
use std::fs;
use std::io::ErrorKind;
use std::iter;
use std::path::Path;
use std::path::{Path, PathBuf};
use std::process::{self, Command, Stdio};
use std::str;

const PRIVATE: &str = "\
#[doc(hidden)]
pub mod __private$$ {
#[doc(hidden)]
pub use crate::private::*;
}
";

fn main() {
println!("cargo:rerun-if-changed=build/probe.rs");

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

let out_dir = PathBuf::from(env::var_os("OUT_DIR").unwrap());
let patch_version = env::var("CARGO_PKG_VERSION_PATCH").unwrap();
let module = PRIVATE.replace("$$", &patch_version);
fs::write(out_dir.join("private.rs"), module).unwrap();

let error_generic_member_access;
let consider_rustc_bootstrap;
if compile_probe(false) {
Expand Down
53 changes: 27 additions & 26 deletions impl/src/expand.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ use crate::ast::{Enum, Field, Input, Struct};
use crate::attr::Trait;
use crate::fallback;
use crate::generics::InferredBounds;
use crate::private;
use crate::unraw::MemberUnraw;
use proc_macro2::{Ident, Span, TokenStream};
use quote::{format_ident, quote, quote_spanned, ToTokens};
Expand Down Expand Up @@ -35,17 +36,17 @@ fn impl_struct(input: Struct) -> TokenStream {
let source_body = if let Some(transparent_attr) = &input.attrs.transparent {
let only_field = &input.fields[0];
if only_field.contains_generic {
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::__private::Error));
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::#private::Error));
}
let member = &only_field.member;
Some(quote_spanned! {transparent_attr.span=>
::thiserror::__private::Error::source(self.#member.as_dyn_error())
::thiserror::#private::Error::source(self.#member.as_dyn_error())
})
} else if let Some(source_field) = input.source_field() {
let source = &source_field.member;
if source_field.contains_generic {
let ty = unoptional_type(source_field.ty);
error_inferred_bounds.insert(ty, quote!(::thiserror::__private::Error + 'static));
error_inferred_bounds.insert(ty, quote!(::thiserror::#private::Error + 'static));
}
let asref = if type_is_option(source_field.ty) {
Some(quote_spanned!(source.span()=> .as_ref()?))
Expand All @@ -63,8 +64,8 @@ fn impl_struct(input: Struct) -> TokenStream {
};
let source_method = source_body.map(|body| {
quote! {
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::__private::Error + 'static)> {
use ::thiserror::__private::AsDynError as _;
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::#private::Error + 'static)> {
use ::thiserror::#private::AsDynError as _;
#body
}
}
Expand All @@ -91,28 +92,28 @@ fn impl_struct(input: Struct) -> TokenStream {
} else if type_is_option(backtrace_field.ty) {
Some(quote! {
if let ::core::option::Option::Some(backtrace) = &self.#backtrace {
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
}
})
} else {
Some(quote! {
#request.provide_ref::<::thiserror::__private::Backtrace>(&self.#backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(&self.#backtrace);
})
};
quote! {
use ::thiserror::__private::ThiserrorProvide as _;
use ::thiserror::#private::ThiserrorProvide as _;
#source_provide
#self_provide
}
} else if type_is_option(backtrace_field.ty) {
quote! {
if let ::core::option::Option::Some(backtrace) = &self.#backtrace {
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
}
}
} else {
quote! {
#request.provide_ref::<::thiserror::__private::Backtrace>(&self.#backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(&self.#backtrace);
}
};
quote! {
Expand Down Expand Up @@ -201,7 +202,7 @@ fn impl_struct(input: Struct) -> TokenStream {
quote! {
#[allow(unused_qualifications)]
#[automatically_derived]
impl #impl_generics ::thiserror::__private::Error for #ty #ty_generics #error_where_clause {
impl #impl_generics ::thiserror::#private::Error for #ty #ty_generics #error_where_clause {
#source_method
#provide_method
}
Expand All @@ -221,11 +222,11 @@ fn impl_enum(input: Enum) -> TokenStream {
if let Some(transparent_attr) = &variant.attrs.transparent {
let only_field = &variant.fields[0];
if only_field.contains_generic {
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::__private::Error));
error_inferred_bounds.insert(only_field.ty, quote!(::thiserror::#private::Error));
}
let member = &only_field.member;
let source = quote_spanned! {transparent_attr.span=>
::thiserror::__private::Error::source(transparent.as_dyn_error())
::thiserror::#private::Error::source(transparent.as_dyn_error())
};
quote! {
#ty::#ident {#member: transparent} => #source,
Expand All @@ -234,7 +235,7 @@ fn impl_enum(input: Enum) -> TokenStream {
let source = &source_field.member;
if source_field.contains_generic {
let ty = unoptional_type(source_field.ty);
error_inferred_bounds.insert(ty, quote!(::thiserror::__private::Error + 'static));
error_inferred_bounds.insert(ty, quote!(::thiserror::#private::Error + 'static));
}
let asref = if type_is_option(source_field.ty) {
Some(quote_spanned!(source.span()=> .as_ref()?))
Expand All @@ -255,8 +256,8 @@ fn impl_enum(input: Enum) -> TokenStream {
}
});
Some(quote! {
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::__private::Error + 'static)> {
use ::thiserror::__private::AsDynError as _;
fn source(&self) -> ::core::option::Option<&(dyn ::thiserror::#private::Error + 'static)> {
use ::thiserror::#private::AsDynError as _;
#[allow(deprecated)]
match self {
#(#arms)*
Expand Down Expand Up @@ -292,12 +293,12 @@ fn impl_enum(input: Enum) -> TokenStream {
let self_provide = if type_is_option(backtrace_field.ty) {
quote! {
if let ::core::option::Option::Some(backtrace) = backtrace {
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
}
}
} else {
quote! {
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
}
};
quote! {
Expand All @@ -306,7 +307,7 @@ fn impl_enum(input: Enum) -> TokenStream {
#source: #varsource,
..
} => {
use ::thiserror::__private::ThiserrorProvide as _;
use ::thiserror::#private::ThiserrorProvide as _;
#source_provide
#self_provide
}
Expand All @@ -330,7 +331,7 @@ fn impl_enum(input: Enum) -> TokenStream {
};
quote! {
#ty::#ident {#backtrace: #varsource, ..} => {
use ::thiserror::__private::ThiserrorProvide as _;
use ::thiserror::#private::ThiserrorProvide as _;
#source_provide
}
}
Expand All @@ -340,12 +341,12 @@ fn impl_enum(input: Enum) -> TokenStream {
let body = if type_is_option(backtrace_field.ty) {
quote! {
if let ::core::option::Option::Some(backtrace) = backtrace {
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
}
}
} else {
quote! {
#request.provide_ref::<::thiserror::__private::Backtrace>(backtrace);
#request.provide_ref::<::thiserror::#private::Backtrace>(backtrace);
}
};
quote! {
Expand Down Expand Up @@ -476,7 +477,7 @@ fn impl_enum(input: Enum) -> TokenStream {
quote! {
#[allow(unused_qualifications)]
#[automatically_derived]
impl #impl_generics ::thiserror::__private::Error for #ty #ty_generics #error_where_clause {
impl #impl_generics ::thiserror::#private::Error for #ty #ty_generics #error_where_clause {
#source_method
#provide_method
}
Expand Down Expand Up @@ -511,7 +512,7 @@ fn fields_pat(fields: &[Field]) -> TokenStream {
fn use_as_display(needs_as_display: bool) -> Option<TokenStream> {
if needs_as_display {
Some(quote! {
use ::thiserror::__private::AsDisplay as _;
use ::thiserror::#private::AsDisplay as _;
})
} else {
None
Expand All @@ -533,11 +534,11 @@ fn from_initializer(
let backtrace_member = &backtrace_field.member;
if type_is_option(backtrace_field.ty) {
quote! {
#backtrace_member: ::core::option::Option::Some(::thiserror::__private::Backtrace::capture()),
#backtrace_member: ::core::option::Option::Some(::thiserror::#private::Backtrace::capture()),
}
} else {
quote! {
#backtrace_member: ::core::convert::From::from(::thiserror::__private::Backtrace::capture()),
#backtrace_member: ::core::convert::From::from(::thiserror::#private::Backtrace::capture()),
}
}
});
Expand Down
3 changes: 2 additions & 1 deletion impl/src/fallback.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
use crate::expand::call_site_ident;
use crate::private;
use proc_macro2::TokenStream;
use quote::quote;
use syn::DeriveInput;
Expand All @@ -14,7 +15,7 @@ pub(crate) fn expand(input: &DeriveInput, error: syn::Error) -> TokenStream {

#[allow(unused_qualifications)]
#[automatically_derived]
impl #impl_generics ::thiserror::__private::Error for #ty #ty_generics #where_clause
impl #impl_generics ::thiserror::#private::Error for #ty #ty_generics #where_clause
where
// Work around trivial bounds being unstable.
// https://github.com/rust-lang/rust/issues/48214
Expand Down
3 changes: 2 additions & 1 deletion impl/src/fmt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::ast::{ContainerKind, Field};
use crate::attr::{Display, Trait};
use crate::private;
use crate::scan_expr::scan_expr;
use crate::unraw::{IdentUnraw, MemberUnraw};
use proc_macro2::{Delimiter, TokenStream, TokenTree};
Expand Down Expand Up @@ -145,7 +146,7 @@ impl Display<'_> {
let wrapped_binding_value = if bonus_display {
quote_spanned!(span=> #binding_value.as_display())
} else if bound == Trait::Pointer {
quote!(::thiserror::__private::Var(#binding_value))
quote!(::thiserror::#private::Var(#binding_value))
} else {
binding_value.into_token_stream()
};
Expand Down
14 changes: 14 additions & 0 deletions impl/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,24 @@ mod unraw;
mod valid;

use proc_macro::TokenStream;
use proc_macro2::{Ident, Span};
use quote::{ToTokens, TokenStreamExt as _};
use syn::{parse_macro_input, DeriveInput};

#[proc_macro_derive(Error, attributes(backtrace, error, from, source))]
pub fn derive_error(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
expand::derive(&input).into()
}

#[allow(non_camel_case_types)]
struct private;

impl ToTokens for private {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
tokens.append(Ident::new(
concat!("__private", env!("CARGO_PKG_VERSION_PATCH")),
Span::call_site(),
));
}
}
21 changes: 3 additions & 18 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,21 +286,6 @@ mod var;

pub use thiserror_impl::*;

// Not public API.
#[doc(hidden)]
pub mod __private {
#[doc(hidden)]
pub use crate::aserror::AsDynError;
#[doc(hidden)]
pub use crate::display::AsDisplay;
#[cfg(error_generic_member_access)]
#[doc(hidden)]
pub use crate::provide::ThiserrorProvide;
#[doc(hidden)]
pub use crate::var::Var;
#[doc(hidden)]
pub use core::error::Error;
#[cfg(all(feature = "std", not(thiserror_no_backtrace_type)))]
#[doc(hidden)]
pub use std::backtrace::Backtrace;
}
mod private;

include!(concat!(env!("OUT_DIR"), "/private.rs"));
14 changes: 14 additions & 0 deletions src/private.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#[doc(hidden)]
pub use crate::aserror::AsDynError;
#[doc(hidden)]
pub use crate::display::AsDisplay;
#[cfg(error_generic_member_access)]
#[doc(hidden)]
pub use crate::provide::ThiserrorProvide;
#[doc(hidden)]
pub use crate::var::Var;
#[doc(hidden)]
pub use core::error::Error;
#[cfg(all(feature = "std", not(thiserror_no_backtrace_type)))]
#[doc(hidden)]
pub use std::backtrace::Backtrace;