NodeState in rustc_data_structures::graph::scc - Rust
Description: API documentation for the Rust `NodeState` enum in crate `rustc_data_structures`.

Skip to main content

## NodeState

# Enum NodeState

Source

    enum NodeState<N, S, A: Annotation> {
        NotVisited,
        BeingVisited {
            depth: usize,
            annotation: A,
        },
        InCycle {
            scc_index: S,
            annotation: A,
        },
        InCycleWith {
            parent: N,
        },
    }

## Variants§

§

### NotVisited

This node has not yet been visited as part of the DFS.

After SCC construction is complete, this state ought to be impossible.

§

### BeingVisited

This node is currently being walked as part of our DFS. It is on the stack at the depth `depth` and its current annotation is `annotation`.

After SCC construction is complete, this state ought to be impossible.

#### Fields

§`depth: usize`
§`annotation: A`
§

### InCycle

Indicates that this node is a member of the given cycle where the merged annotation is `annotation`. Note that an SCC can have several cycles, so its final annotation is the merged value of all its member annotations.

#### Fields

§`scc_index: S`
§`annotation: A`
§

### InCycleWith

Indicates that this node is a member of whatever cycle `parent` is a member of. This state is transient: whenever we see it, we try to overwrite it with the current state of `parent` (this is the “path compression” step of a union-find algorithm).

#### Fields

§`parent: N`

## Trait Implementations§

Source§

### impl<N: Clone, S: Clone, A: Clone + Annotation> Clone for NodeState<N, S, A>

Source§

#### fn clone(&self) -> NodeState<N, S, A>

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<N: Copy, S: Copy, A: Copy + Annotation> Copy for NodeState<N, S, A>

Source§

### impl<N: Debug, S: Debug, A: Debug + Annotation> Debug for NodeState<N, S, A>

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl<N, S, A> DynSend for NodeState<N, S, A>
where A: DynSend, S: DynSend, N: DynSend,

§

### impl<N, S, A> DynSync for NodeState<N, S, A>
where A: DynSync, S: DynSync, N: DynSync,

§

### impl<N, S, A> Freeze for NodeState<N, S, A>
where A: Freeze, S: Freeze, N: Freeze,

§

### impl<N, S, A> RefUnwindSafe for NodeState<N, S, A>
where A: RefUnwindSafe, S: RefUnwindSafe, N: RefUnwindSafe,

§

### impl<N, S, A> Send for NodeState<N, S, A>
where A: Send, S: Send, N: Send,

§

### impl<N, S, A> Sync for NodeState<N, S, A>
where A: Sync, S: Sync, N: Sync,

§

### impl<N, S, A> Unpin for NodeState<N, S, A>
where A: Unpin, S: Unpin, N: Unpin,

§

### impl<N, S, A> UnsafeUnpin for NodeState<N, S, A>
where A: UnsafeUnpin, S: UnsafeUnpin, N: UnsafeUnpin,

§

### impl<N, S, A> UnwindSafe for NodeState<N, S, A>
where A: UnwindSafe, S: UnwindSafe, N: UnwindSafe,

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment = const ALIGN: Alignment = Alignment::of::<Self>();

Alignment of `Self`.
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<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
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> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.