Struct EdgeSearch

#[non_exhaustive]
pub struct EdgeSearch<'search, Graph>
where
    Graph: Graph,
{
    pub label: Option<<Graph::Edge as Element>::Label>,
    pub adjacent_label: Option<<Graph::Vertex as Element>::Label>,
    pub direction: Direction,
    pub limit: Option<usize>,
    /* private fields */
}

A search to apply to edges when querying a graph. This allows graph implementations to support vertex centric indexes. In the future, this will be expanded to support more complex filters than just label and direction.

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.

label: Option<<Graph::Edge as Element>::Label>

the label of the edges

adjacent_label: Option<<Graph::Vertex as Element>::Label>

The required adjacent label

direction: Direction

The direction of the edge to match.

limit: Option<usize>

The maximum number of edges to return for the current vertex

Implementations

impl<Graph> EdgeSearch<'_, Graph>

where Graph: Graph,

pub fn scan() -> Self

Creates a new edge search with default settings.

This creates an edge search that will match all edges, regardless of label, adjacent label, or direction.

Returns

A new EdgeSearch with default settings.

pub fn label(label: <Graph::Edge as Element>::Label) -> Self

Edges must match the label

pub fn outgoing(self) -> Self

Outgoing edges

pub fn incoming(self) -> Self

Outgoing edges

pub fn direction(self, direction: Direction) -> Self

The direction of the edges relative to the starting vertex

pub fn take(self, n: usize) -> Self

The maximum number of edges to return relative to the starting vertex.

The name take follows Rust’s standard library’s naming conventions.

pub fn with_limit(self, limit: usize) -> Self

The maximum number of edges to return relative to the starting vertex.

pub fn limit(&self) -> usize

Returns the maximum number of edges to return from this search.

If no limit was set, returns usize::MAX (effectively no limit).

Returns

The edge limit, or usize::MAX if no limit was set

pub fn adjacent_labelled( self, adjacent_label: <Graph::Vertex as Element>::Label, ) -> Self

where Graph: Graph + SupportsEdgeAdjacentLabelIndex,

Adjacent vertex label must match

Trait Implementations

impl<Graph> Clone for EdgeSearch<'_, Graph>

where Graph: Graph,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Graph> Default for EdgeSearch<'_, Graph>

where Graph: Graph,

fn default() -> Self

Returns the “default value” for a type.