Struct Edge

#[non_exhaustive]
pub struct Edge {
    pub source: String,
    pub target: String,
    pub external: bool,
    pub import_kinds: ImportKindSet,
}

One directed dependency in an extracted Rust project.

Internal endpoints are normalized workspace-relative file identifiers. When Self::external is true, target is instead the Cargo-visible crate name used in source.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

source: String

The internal file containing the dependency syntax.

target: String

The internal target file or external Cargo-visible crate name.

external: bool

Whether the target is outside the analyzed workspace.

import_kinds: ImportKindSet

Every Rust syntax form that produced this source-target pair.

Implementations

impl Edge

pub fn new( source: impl AsRef<str>, target: impl AsRef<str>, external: bool, import_kinds: impl IntoIterator<Item = ImportKind>, ) -> Self

Builds an edge and lexically normalizes both identifiers.

An edge whose normalized endpoints are equal is canonicalized to Self::self_edge.

pub fn self_edge(identifier: impl AsRef<str>) -> Self

Builds the marker edge that keeps a dependency-free file in the graph.

pub fn is_self_edge(&self) -> bool

Returns whether this edge is the marker from a file to itself.

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl Display for Edge

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

Formats the value using the given formatter.

impl FromIterator<Edge> for Graph

fn from_iter<T: IntoIterator<Item = Edge>>(edges: T) -> Self

Creates a value from an iterator.

impl Hash for Edge

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Edge

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Edge

impl StructuralPartialEq for Edge