Struct GraphQueryOptions

#[non_exhaustive]
pub struct GraphQueryOptions { /* private fields */ }

Immutable selection, collapse, and presentation options for one graph snapshot.

Implementations

impl GraphQueryOptions

pub const fn new() -> Self

Creates the complete, uncollapsed internal graph query.

pub const fn with_external_dependencies(self, include: bool) -> Self

Controls whether external dependency targets and edges appear.

pub const fn with_self_dependencies(self, include: bool) -> Self

Controls whether extracted and collapse-produced self edges appear.

pub fn with_focus(self, focus: Filter, depth: usize) -> Self

Adds an undirected focus query expanded to depth neighbors.

pub fn with_reachable_from(self, reachable_from: Filter) -> Self

Adds a transitive outgoing-dependency query.

pub fn with_dependents_of(self, dependents_of: Filter) -> Self

Adds a transitive incoming-dependent query.

pub fn with_collapse(self, collapse: GraphCollapse) -> Self

Selects one node-collapse strategy.

pub fn with_title( self, title: impl Into<String>, ) -> Result<Self, GraphQueryError>

Sets a non-empty report title.

pub const fn includes_external_dependencies(&self) -> bool

Returns whether external dependencies participate in this query.

pub const fn includes_self_dependencies(&self) -> bool

Returns whether self dependencies participate in the report.

pub const fn focus(&self) -> Option<&Filter>

Returns the optional focus selector.

pub const fn focus_depth(&self) -> usize

Returns the undirected focus expansion depth.

pub const fn reachable_from(&self) -> Option<&Filter>

Returns the optional outgoing traversal selector.

pub const fn dependents_of(&self) -> Option<&Filter>

Returns the optional incoming traversal selector.

pub const fn collapse(&self) -> Option<&GraphCollapse>

Returns the optional node-collapse strategy.

pub fn title(&self) -> Option<&str>

Returns the custom report title, if configured.

Trait Implementations

impl Clone for GraphQueryOptions

fn clone(&self) -> GraphQueryOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GraphQueryOptions

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

Formats the value using the given formatter.

impl Default for GraphQueryOptions

fn default() -> Self

Returns the “default value” for a type.