Skip to content
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.

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

fix(error): Polish Incomplete handling #724

Merged
merged 3 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions src/binary/bits/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ where
*input = rest;
Ok(result)
}
Err(e) => match e.into_needed() {
Ok(n) => Err(ParserError::incomplete(
Err(e) => match e.needed() {
Some(n) => Err(ParserError::incomplete(
input,
n.map(|u| u.get() / BYTE + 1),
)),
Err(e) => Err(ErrorConvert::convert(e)),
None => Err(ErrorConvert::convert(e)),
},
}
})
Expand Down Expand Up @@ -138,16 +138,16 @@ where
*bit_input = (input, 0);
Ok(res)
}
Err(e) => match e.into_needed() {
Ok(Needed::Unknown) => Err(ParserError::incomplete(bit_input, Needed::Unknown)),
Ok(Needed::Size(sz)) => Err(match sz.get().checked_mul(BYTE) {
Err(e) => match e.needed() {
Some(Needed::Unknown) => Err(ParserError::incomplete(bit_input, Needed::Unknown)),
Some(Needed::Size(sz)) => Err(match sz.get().checked_mul(BYTE) {
Some(v) => ParserError::incomplete(bit_input, Needed::new(v)),
None => ParserError::assert(
bit_input,
"overflow in turning needed bytes into needed bits",
),
}),
Err(e) => Err(ErrorConvert::convert(e)),
None => Err(ErrorConvert::convert(e)),
},
}
})
Expand Down
2 changes: 1 addition & 1 deletion src/combinator/debug/internals.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ impl Severity {
match result {
Ok(_) => Self::Success,
Err(e) if e.is_backtrack() => Self::Backtrack,
Err(e) if e.is_needed() => Self::Incomplete,
Err(e) if e.is_incomplete() => Self::Incomplete,
_ => Self::Cut,
}
}
Expand Down
10 changes: 5 additions & 5 deletions src/combinator/impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,9 @@ where
fn parse_next(&mut self, input: &mut I) -> Result<O, E> {
trace("complete_err", |input: &mut I| {
match (self.p).parse_next(input) {
Err(err) => match err.into_needed() {
Ok(_) => Err(ParserError::from_input(input)),
Err(err) => Err(err),
Err(err) => match err.needed() {
Some(_) => Err(ParserError::from_input(input)),
None => Err(err),
},
rest => rest,
}
Expand Down Expand Up @@ -641,7 +641,7 @@ where
Ok(o) => {
return Ok(o);
}
Err(e) if e.is_needed() => return Err(e),
Err(e) if e.is_incomplete() => return Err(e),
Err(err) => err,
};
let err_start = i.checkpoint();
Expand Down Expand Up @@ -720,7 +720,7 @@ where
Ok(o) => {
return Ok(Some(o));
}
Err(e) if e.is_needed() => return Err(e),
Err(e) if e.is_incomplete() => return Err(e),
Err(err) => err,
};
let err_start = i.checkpoint();
Expand Down
19 changes: 12 additions & 7 deletions src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -213,15 +213,15 @@ impl<I: Stream, E: ParserError<I>> ParserError<I> for ErrMode<E> {
}

#[inline(always)]
fn is_needed(&self) -> bool {
fn is_incomplete(&self) -> bool {
matches!(self, ErrMode::Incomplete(_))
}

#[inline(always)]
fn into_needed(self) -> Result<Needed, Self> {
fn needed(&self) -> Option<Needed> {
match self {
ErrMode::Incomplete(needed) => Ok(needed),
err => Err(err),
ErrMode::Incomplete(needed) => Some(*needed),
_ => None,
}
}
}
Expand Down Expand Up @@ -403,15 +403,20 @@ pub trait ParserError<I: Stream>: Sized {
fn into_inner(self) -> Result<Self::Inner, Self>;

/// Is more data [`Needed`]
///
/// This must be the same as [`err.needed().is_some()`][ParserError::needed]
#[inline(always)]
fn is_needed(&self) -> bool {
fn is_incomplete(&self) -> bool {
false
}

/// Extract the [`Needed`] data, if present
///
/// `Self::needed().is_some()` must be the same as
/// [`err.is_incomplete()`][ParserError::is_incomplete]
#[inline(always)]
fn into_needed(self) -> Result<Needed, Self> {
Err(self)
fn needed(&self) -> Option<Needed> {
None
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/stream/recoverable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ where
err: E,
) -> Result<(), E> {
if self.is_recoverable {
if err.is_needed() {
if err.is_incomplete() {
Err(err)
} else {
self.errors
Expand Down