Define a kani::invariant
attribute
#3270
Draft
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.
This PR defines a
#[kani::invariant(<pred>)]
macro attribute that allows users to define the type invariant as the predicate passed as an argument to the attribute. This relieves users from writing the wholeimpl kani::Invariant ...
for their types and helps keep the type and its invariant as close as possible.An example:
Keeping this as a draft while we:
kani::invariant
annotations?).Extend its functionality a little more (I'd like to check if we can use helper attributes to directly define the invariants on fields) or discuss other features to be implemented now or later.Resolves #3095
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.