Skip to main content

SubtreeSkip

Struct SubtreeSkip 

Source
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

Source

pub const RETAIN: Self

Keep this node. Answers for nothing else.

Source

pub const SKIP: Self

Elide this node and its descendants. Answers for nothing else.

Source

pub const fn of(skipped: bool) -> Self

Self::SKIP or Self::RETAIN, from a predicate’s answer.

Source

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.

Source

pub const fn is_skipped(self) -> bool

Whether this node and its descendants are elided.

Source

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.

Source

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for SubtreeSkip

Source§

impl Debug for SubtreeSkip

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for SubtreeSkip

Source§

impl PartialEq for SubtreeSkip

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SubtreeSkip

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.