Skip to content

emit the error module only when something references it #1080

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
ahl merged 1 commit into from
Sep 19, 2026
Merged

emit the error module only when something references it #1080

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
26 changes: 0 additions & 26 deletions cargo-typify/tests/outputs/attr.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,29 +68,3 @@ pub struct Veggies {
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub vegetables: ::std::vec::Vec<Veggie>,
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
26 changes: 0 additions & 26 deletions cargo-typify/tests/outputs/derive.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,29 +64,3 @@ pub struct Veggies {
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub vegetables: ::std::vec::Vec<Veggie>,
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
26 changes: 0 additions & 26 deletions cargo-typify/tests/outputs/multi_derive.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,29 +78,3 @@ pub struct Veggies {
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub vegetables: ::std::vec::Vec<Veggie>,
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
26 changes: 0 additions & 26 deletions cargo-typify/tests/outputs/no-builder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,29 +64,3 @@ pub struct Veggies {
#[serde(default, skip_serializing_if = "::std::vec::Vec::is_empty")]
pub vegetables: ::std::vec::Vec<Veggie>,
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
2 changes: 1 addition & 1 deletion typify-impl/src/convert.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2299,7 +2299,7 @@ mod tests {
let actual = type_space.to_stream();
let file = syn::parse2::<syn::File>(actual).expect("type space should emit a valid file");
match file.items.as_slice() {
[syn::Item::Mod(error)] if error.ident == "error" => {}
[] => {}
_ => panic!("unexpected file contents {}", file.to_token_stream()),
}
}
Expand Down
36 changes: 22 additions & 14 deletions typify-impl/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,8 +902,28 @@ impl TypeSpace {
pub fn to_stream(&self) -> TokenStream {
let mut output = OutputSpace::default();

// Add the error type we use for conversions; it's fine if this is
// unused.
// Add all types.
self.id_to_entry
.values()
.for_each(|type_entry| type_entry.output(self, &mut output));

// Add all shared default functions.
self.defaults
.iter()
.for_each(|x| output.add_item(output::OutputSpaceMod::Defaults, "", x.into()));

// Add the error type conversions use, but only when some emitted item
// references it. This is kind of gross that we're groveling around
// through output to decide, but it will--I hope--be short-lived.
if output.contains("ConversionError") {
self.add_error_item(&mut output);
}

output.into_stream()
}

/// The error type generated `TryFrom` and `FromStr` impls report.
fn add_error_item(&self, output: &mut OutputSpace) {
output.add_item(
output::OutputSpaceMod::Error,
"",
Expand Down Expand Up @@ -939,18 +959,6 @@ impl TypeSpace {
}
},
);

// Add all types.
self.id_to_entry
.values()
.for_each(|type_entry| type_entry.output(self, &mut output));

// Add all shared default functions.
self.defaults
.iter()
.for_each(|x| output.add_item(output::OutputSpaceMod::Defaults, "", x.into()));

output.into_stream()
}

/// Allocated the next TypeId.
Expand Down
7 changes: 7 additions & 0 deletions typify-impl/src/output.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ impl OutputSpace {
.extend(stream);
}

/// Whether any accumulated item's tokens contain `needle`.
pub fn contains(&self, needle: &str) -> bool {
self.items
.values()
.any(|stream| stream.to_string().contains(needle))
}

pub fn into_stream(self) -> TokenStream {
let mods = self
.items
Expand Down
26 changes: 0 additions & 26 deletions typify/tests/schemas/arrays-and-tuples.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,30 +139,4 @@ impl ::std::convert::From<[::serde_json::Value; 2usize]> for YoloTwoArray {
Self(value)
}
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
fn main() {}
26 changes: 0 additions & 26 deletions typify/tests/schemas/maps.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,30 +181,4 @@ impl ::std::str::FromStr for Value {
Ok(Self(value.to_string()))
}
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
fn main() {}
26 changes: 0 additions & 26 deletions typify/tests/schemas/maps_custom.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,30 +181,4 @@ impl ::std::str::FromStr for Value {
Ok(Self(value.to_string()))
}
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
fn main() {}
26 changes: 0 additions & 26 deletions typify/tests/schemas/multiple-instance-types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,30 +107,4 @@ impl ::std::convert::From<bool> for YesNoMaybe {
Self::Boolean(value)
}
}
#[doc = " Error types."]
pub mod error {
#[doc = r" Error from a `TryFrom` or `FromStr` implementation."]
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
fn main() {}
Loading