Enum VertexSearch

#[non_exhaustive]
pub enum VertexSearch<'search, Graph>
where
    Graph: Graph,
{
    Scan {
        limit: Option<usize>,
    },
    Label {
        label: <Graph::Vertex as Element>::Label,
        limit: Option<usize>,
    },
    Index {
        index: <<Graph::Vertex as Element>::Label as Label>::Index,
        value: Value<'search>,
        limit: Option<usize>,
    },
    Range {
        index: <<Graph::Vertex as Element>::Label as Label>::Index,
        range: Range<Value<'search>>,
        limit: Option<usize>,
    },
    FullText {
        index: <<Graph::Vertex as Element>::Label as Label>::Index,
        search: Value<'search>,
        limit: Option<usize>,
    },
}

A search to apply to vertices when querying a graph.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Scan

Fields

limit: Option<usize>

Label

Fields

label: <Graph::Vertex as Element>::Label

limit: Option<usize>

Index

Fields

index: <<Graph::Vertex as Element>::Label as Label>::Index

value: Value<'search>

limit: Option<usize>

Range

Fields

index: <<Graph::Vertex as Element>::Label as Label>::Index

range: Range<Value<'search>>

limit: Option<usize>

FullText

Fields

index: <<Graph::Vertex as Element>::Label as Label>::Index

search: Value<'search>

limit: Option<usize>

Implementations

impl<'search, Graph> VertexSearch<'search, Graph>

where Graph: Graph,

pub fn scan() -> Self

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

where Graph: Graph + SupportsVertexLabelIndex,

pub fn get<V>( index: <<Graph::Vertex as Element>::Label as Label>::Index, value: V, ) -> Self

where V: Into<Value<'search>>, Graph: Graph + SupportsVertexHashIndex,

pub fn range<R>( index: <<Graph::Vertex as Element>::Label as Label>::Index, range: R, ) -> Self

where R: Into<ValueRange<'search>>, Graph: Graph + SupportsVertexRangeIndex,

pub fn full_text( index: <<Graph::Vertex as Element>::Label as Label>::Index, search: &'search str, ) -> Self

where Graph: Graph + SupportsVertexFullTextIndex,

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

The maximum number of vertices to return from this search

pub fn limit(&self) -> usize

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

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

Returns

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

Trait Implementations

impl<'search, Graph> Clone for VertexSearch<'search, 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.