Struct PackageCycle 

pub struct PackageCycle {
    pub packages: Vec<String>,
    pub package_roots: Vec<PathBuf>,
    pub length: usize,
    pub edges: Vec<PackageCycleEdge>,
    pub group_truncated: bool,
}

A dependency cycle between workspace packages.

Each workspace package is a node. A resolved import from a file in one package to a file in another package is an edge. Declared package.json dependencies are not edges, and imports from test, spec, story, fixture and tooling config files are not edges. A package cycle can exist when no file-level cycle exists.

Fields

packages: Vec<String>

Workspace package labels in cycle order. The first entry is the lexicographically smallest label; the last entry imports the first. A label is the package name. When two or more workspace packages share a name, the label is name (root) with the project-relative package root, so that each label names one package.

package_roots: Vec<PathBuf>

Package root directories in cycle order: package_roots[i] is the root of packages[i].

length: usize

Number of packages in the cycle.

edges: Vec<PackageCycleEdge>

One example import per hop, in cycle order: edges[i] goes from packages[i] to packages[(i + 1) % length].

group_truncated: bool

True when the group of packages that holds this cycle has more cycles than fallow lists. The listing stops at 20 cycles per group, or earlier on a very dense package graph. Break a listed cycle and run again to see the rest.

Implementations

impl PackageCycle

pub const GROUP_TRUNCATED_NOTE: &'static str = "this package group has more cycles than listed"

The note that every output format shows for a cycle with PackageCycle::group_truncated set.

pub fn chain(&self, separator: &str) -> String

The package labels in cycle order, with the first label repeated at the end, joined with separator.

Trait Implementations

impl Clone for PackageCycle

fn clone(&self) -> PackageCycle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageCycle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageCycle

fn deserialize<__D>( __deserializer: __D, ) -> Result<PackageCycle, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PackageCycle

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for PackageCycle

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.