pub struct SubtreeSkip { /* private fields */ }Expand description
A [Checker::should_skip_subtree] verdict, plus the following
nodes it also answers for.
Most verdicts are about one node and carry no reach. The exception
is a verdict a classifier can only reach by reading a run of
siblings: Rust’s #[…] rows all decorate the same item, so they all
get the same answer, and re-deriving it per row is O(run) work
done run times. A run of 3 * depth attributes on one deep parent
made that quadratic — 5.2 s at depth 2 000, against 0.05 s with
exclude_tests off (#1446). Reporting the reach lets the walker ask
the classifier once per run.
§Soundness
The reach is a byte offset, and the walk visits nodes in
non-decreasing start_byte order, so “starts before it” is a state
the walker can test in O(1) and can never re-enter. A claim is
sound when every node the walk visits inside the reach genuinely
has the reported verdict.
“Visits” is the load-bearing word, and it cuts the obligation in
two. A SKIP reach need only hold for the nodes it skips, since a
skipped node’s descendants are never pushed. A RETAIN reach
carries the heavier claim: the members’ descendants are walked, so
it must be right for them too.
A verdict can also answer for one node named by identity, where the
reach stops (Self::covering_through_node). That claim is about
the node alone: its descendants are not inside the reach, so a
RETAIN walk still asks about each of them. It cannot be re-entered
either, since an id is unique within one tree and a pre-order walk
visits each node once.
Implementations§
Source§impl SubtreeSkip
impl SubtreeSkip
Sourcepub const fn of(skipped: bool) -> Self
pub const fn of(skipped: bool) -> Self
Self::SKIP or Self::RETAIN, from a predicate’s answer.
Sourcepub const fn covering_through(self, byte: usize) -> Self
pub const fn covering_through(self, byte: usize) -> Self
Extend this verdict to every node that starts before byte.
The caller is asserting that it read far enough to answer for all of them — see the soundness note on the type.
Sourcepub const fn is_skipped(self) -> bool
pub const fn is_skipped(self) -> bool
Whether this node and its descendants are elided.
Sourcepub fn covering_through_node(self, node: &Node<'_>) -> Self
pub fn covering_through_node(self, node: &Node<'_>) -> Self
Self::covering_through node’s start, plus node itself.
The caller is asserting that this verdict is also node’s own.
Naming node by identity, rather than moving the reach past its
start, leaves its descendants out: its first child starts at the
same byte.
Sourcepub fn answers_for(self, node: &Node<'_>) -> bool
pub fn answers_for(self, node: &Node<'_>) -> bool
Whether this verdict already answers for node, so the
classifier need not be asked again.
Trait Implementations§
Source§impl Clone for SubtreeSkip
impl Clone for SubtreeSkip
impl Copy for SubtreeSkip
Source§impl Debug for SubtreeSkip
impl Debug for SubtreeSkip
impl Eq for SubtreeSkip
Source§impl PartialEq for SubtreeSkip
impl PartialEq for SubtreeSkip
impl StructuralPartialEq for SubtreeSkip
Auto Trait Implementations§
impl Forget for SubtreeSkip
impl Freeze for SubtreeSkip
impl RefUnwindSafe for SubtreeSkip
impl Send for SubtreeSkip
impl Sync for SubtreeSkip
impl Unpin for SubtreeSkip
impl UnsafeUnpin for SubtreeSkip
impl UnwindSafe for SubtreeSkip
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.