feat: allow cancelling the solving process #20
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces a
should_cancel_with_value
method inDependencyProvider
,that returns an
Option<Box<dyn Any>>
. This method is called at thebeginning of each unit propagation round and before potentially blocking
operations (like [Self::get_dependencies] and [Self::get_candidates]).
If
should_cancel_with_value
returnsSome(...)
,propagation is interrupted and the solver returns
Err(UnsolvableOrCancelled::Cancelled(...))
, bubbling up the value tothe library user (this way you can handle any additional details
surrounding the cancellation outside of the solver).
Closes #8.
Remarks
SolverCache::provider
is nowpub(crate)
. Is that all right?DependencyProvider
to use interior mutability to track cancellation. I think that's reasonable, because otherwise we would need to take&mut self
in all ofDependencyProvider
methods, but I'm mentioning it here in case anyone has a different opinion.