Skip to content

rename InternalError variants by whether they carry a span #228

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

rename InternalError variants by whether they carry a span #228

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
4 changes: 2 additions & 2 deletions src/ibidem.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ thread_local! {
// `set_parse_error`.
// 2. `ParseWrapper::deserialize` calls `D::Error::custom(msg)`.
// 3. `InternalError::custom` calls `take_parse_error` and, if set,
// returns `InternalError::Normal(syn_error)` instead of
// `InternalError::NoData(msg)`.
// returns `InternalError::Spanned(syn_error)` instead of
// `InternalError::Unspanned(msg)`.
//
// As with `WRAPPER_TOKENS`, the set/take sequence is immediate.
static PARSE_ERROR: RefCell<Option<syn::Error>> = Default::default();
Expand Down
56 changes: 28 additions & 28 deletions src/serde_tokenstream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,11 @@ where
)),
},
// Pass through expected errors.
Err(InternalError::Normal(err)) => Err(err),
Err(InternalError::Spanned(err)) => Err(err),

// Other errors should not be able to reach this point.
Err(InternalError::NoData(msg)) => panic!(
"Error::NoData should never propagate to the caller: {}",
Err(InternalError::Unspanned(msg)) => panic!(
"Error::Unspanned should never propagate to the caller: {}",
msg
),
Err(InternalError::Unknown) => {
Expand All @@ -157,8 +157,8 @@ where

#[derive(Clone, Debug)]
enum InternalError {
Normal(Error),
NoData(String),
Spanned(Error),
Unspanned(String),
Unknown,
}

Expand Down Expand Up @@ -203,7 +203,7 @@ impl<'de> TokenDe {
match self.next() {
None => Ok(()),
Some(TokenTree::Punct(punct)) if punct.as_char() == ',' => Ok(()),
Some(token) => Err(InternalError::Normal(Error::new(
Some(token) => Err(InternalError::Spanned(Error::new(
token.span(),
format!("expected `,` or nothing, but found `{}`", token),
))),
Expand All @@ -224,7 +224,7 @@ impl<'de> TokenDe {

fn last_err<T>(&self, what: &str) -> InternalResult<T> {
match &self.last {
Some(token) => Err(InternalError::Normal(Error::new(
Some(token) => Err(InternalError::Spanned(Error::new(
token.span(),
format!("expected {} following `{}`", what, token),
))),
Expand All @@ -242,7 +242,7 @@ impl<'de> TokenDe {
what: &str,
) -> InternalResult<VV> {
match next {
Some(token) => Err(InternalError::Normal(Error::new(
Some(token) => Err(InternalError::Spanned(Error::new(
token.span(),
format!("expected {}, but found `{}`", what, token),
))),
Expand Down Expand Up @@ -333,9 +333,9 @@ impl serde::de::Error for InternalError {
// information via the PARSE_ERROR side channel. If so, use it
// directly to preserve the span.
if let Some(parse_err) = take_parse_error() {
InternalError::Normal(parse_err)
InternalError::Spanned(parse_err)
} else {
InternalError::NoData(format!("{}", msg))
InternalError::Unspanned(format!("{}", msg))
}
}
}
Expand Down Expand Up @@ -369,13 +369,13 @@ impl<'de> MapAccess<'de> for TokenDe {
}

Some(token) => {
return Err(InternalError::Normal(Error::new(
return Err(InternalError::Spanned(Error::new(
token.span(),
format!("expected `=`, but found `{}`", token),
)));
}
None => {
return Err(InternalError::Normal(Error::new(
return Err(InternalError::Spanned(Error::new(
keytok.span(),
format!("expected `=` following `{}`", keytok),
)));
Expand Down Expand Up @@ -403,9 +403,9 @@ impl<'de> MapAccess<'de> for TokenDe {
Ok(_) => {
self.gobble_optional_comma()?;
}
Err(InternalError::NoData(msg)) => {
Err(InternalError::Unspanned(msg)) => {
if let Some(span) = valtok {
return Err(InternalError::Normal(Error::new(span, msg)));
return Err(InternalError::Spanned(Error::new(span, msg)));
}
}
Err(_) => (),
Expand Down Expand Up @@ -452,9 +452,9 @@ impl<'de> EnumAccess<'de> for &mut TokenDe {
match val {
Ok(v) => Ok((v, self)),
// If there wan an error from serde, tag it with the current token.
Err(InternalError::NoData(msg)) => match &self.current {
Err(InternalError::Unspanned(msg)) => match &self.current {
Some(token) => {
Err(InternalError::Normal(Error::new(token.span(), msg)))
Err(InternalError::Spanned(Error::new(token.span(), msg)))
}
// This can't happen; we will need to have read a token at
// this point.
Expand Down Expand Up @@ -502,8 +502,8 @@ impl<'de> VariantAccess<'de> for &mut TokenDe {
return match visitor
.visit_seq(TokenDe::new(&group.stream()))
{
Err(InternalError::NoData(msg)) => {
Err(InternalError::Normal(Error::new(
Err(InternalError::Unspanned(msg)) => {
Err(InternalError::Spanned(Error::new(
token.span(),
msg,
)))
Expand Down Expand Up @@ -535,8 +535,8 @@ impl<'de> VariantAccess<'de> for &mut TokenDe {
// deserialize_ignored_any to determine if the
// given field is valid.
match visitor.visit_map(TokenDe::new(&group.stream())) {
Err(InternalError::NoData(msg)) => {
return Err(InternalError::Normal(Error::new(
Err(InternalError::Unspanned(msg)) => {
return Err(InternalError::Spanned(Error::new(
token.span(),
msg,
)));
Expand Down Expand Up @@ -633,8 +633,8 @@ impl<'de> Deserializer<'de> for &mut TokenDe {
return match visitor
.visit_seq(TokenDe::new(&group.stream()))
{
Err(InternalError::NoData(msg)) => {
Err(InternalError::Normal(Error::new(
Err(InternalError::Unspanned(msg)) => {
Err(InternalError::Spanned(Error::new(
token.span(),
msg,
)))
Expand Down Expand Up @@ -667,8 +667,8 @@ impl<'de> Deserializer<'de> for &mut TokenDe {
// deserialize_ignored_any to determine if the
// given field is valid.
match visitor.visit_map(TokenDe::new(&group.stream())) {
Err(InternalError::NoData(msg)) => {
return Err(InternalError::Normal(Error::new(
Err(InternalError::Unspanned(msg)) => {
return Err(InternalError::Spanned(Error::new(
token.span(),
msg,
)));
Expand Down Expand Up @@ -772,8 +772,8 @@ impl<'de> Deserializer<'de> for &mut TokenDe {
return match visitor
.visit_seq(TokenDe::new(&group.stream()))
{
Err(InternalError::NoData(msg)) => {
Err(InternalError::Normal(Error::new(
Err(InternalError::Unspanned(msg)) => {
Err(InternalError::Spanned(Error::new(
token.span(),
msg,
)))
Expand Down Expand Up @@ -1004,11 +1004,11 @@ impl<'de> Deserializer<'de> for &mut TokenDe {
let mut err = Error::new_spanned(ts, msg);

// Add in the value error if there was one.
if let Err(InternalError::Normal(e2)) = value {
if let Err(InternalError::Spanned(e2)) = value {
err.combine(e2);
}

Err(InternalError::Normal(err))
Err(InternalError::Spanned(err))
}
}

Expand Down
Loading