Struct GraphSelection 

pub struct GraphSelection { /* private fields */ }

Typed inputs used to construct the one graph-loading read batch.

Implementations

impl GraphSelection

pub fn new( node_traversal: Traversal<OnNodes, ReadOnly>, edge_traversal: Traversal<OnEdges, ReadOnly>, direction: GraphDirection, ) -> Self

Construct a filtered selection from node- and edge-producing read traversals.

pub fn allow_full_scan(self) -> Self

Explicitly permit unfiltered node and edge traversals.

pub fn with_node_properties( self, properties: impl IntoIterator<Item = impl Into<String>>, ) -> Result<Self, GraphSelectionError>

Select node properties retained by the graph.

pub fn with_edge_properties( self, properties: impl IntoIterator<Item = impl Into<String>>, ) -> Result<Self, GraphSelectionError>

Select edge properties retained by the graph.

pub fn with_external_identity( self, property: impl Into<String>, ) -> Result<Self, GraphSelectionError>

Use a selected node property as the public graph node identity.

pub fn with_graphify_edge_key( self, property: impl Into<String>, ) -> Result<Self, GraphSelectionError>

Preserve a Graphify multigraph key separately from the Helix edge ID.

pub fn with_weight( self, property: impl Into<String>, ) -> Result<Self, GraphSelectionError>

Select the non-negative finite numeric edge weight used by weighted algorithms.

pub fn with_node_limit(self, limit: NonZeroUsize) -> Self

Reject selections returning more than limit nodes.

pub fn with_edge_limit(self, limit: NonZeroUsize) -> Self

Reject selections returning more than limit edges.

pub const fn direction(&self) -> GraphDirection

Direction semantics of the constructed graph.

pub const fn scan_policy(&self) -> GraphScanPolicy

Full-scan policy chosen by the caller.

pub fn to_query_request(&self) -> QueryRequest

Build the ordinary read request used by Client::graph.

Trait Implementations

impl Clone for GraphSelection

fn clone(&self) -> GraphSelection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphSelection

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

Formats the value using the given formatter.

impl PartialEq for GraphSelection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GraphSelection