Skip to main content

PathStep

Struct PathStep 

Source
pub struct PathStep {
    pub direction: Direction,
    pub filter: StepFilter,
    pub min_hops: usize,
    pub max_hops: Option<usize>,
}
Expand description

A single step in a path pattern.

Each step specifies a direction, edge filter, and optional hop range.

Fields§

§direction: Direction

Direction to traverse for this step.

§filter: StepFilter

Filter for edges in this step.

§min_hops: usize

Minimum number of hops (default: 1).

§max_hops: Option<usize>

Maximum number of hops (default: 1). Use None for unlimited (variable length patterns).

Implementations§

Source§

impl PathStep

Source

pub fn new(direction: Direction, filter: impl Into<StepFilter>) -> Self

Create a new single-hop step.

Source

pub fn any(direction: Direction) -> Self

Create a step that matches any edge in the given direction.

Source

pub fn outgoing(edge_type: impl Into<EdgeType>) -> Self

Create an outgoing step with the given edge type.

Source

pub fn incoming(edge_type: impl Into<EdgeType>) -> Self

Create an incoming step with the given edge type.

Source

pub fn both(edge_type: impl Into<EdgeType>) -> Self

Create a bidirectional step with the given edge type.

Source

pub const fn with_hops(self, min: usize, max: Option<usize>) -> Self

Set the hop range for this step.

§Arguments
  • min - Minimum number of hops
  • max - Maximum number of hops (None for unlimited)
Source

pub const fn variable_length(self, min: usize, max: usize) -> Self

Make this a variable-length step with the given range.

Equivalent to Cypher’s *min..max syntax.

Source

pub const fn optional(self) -> Self

Make this step optional (0 or 1 hops).

Source

pub const fn zero_or_more(self) -> Self

Make this step repeat any number of times (0 or more).

Source

pub const fn one_or_more(self) -> Self

Make this step repeat one or more times.

Source

pub fn is_variable_length(&self) -> bool

Check if this step is variable length.

Trait Implementations§

Source§

impl Clone for PathStep

Source§

fn clone(&self) -> PathStep

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PathStep

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more