Skip to main content

TraverseLimits

Struct TraverseLimits 

Source
pub struct TraverseLimits {
    pub result_limit: NonZeroUsize,
    pub max_depth: Option<NonZeroU32>,
}
Expand description

Limits for a single traverse query (result cap and optional hop bound).

§Semantics

  • result_limit: maximum nodes returned or counted; each seed counts toward the cap.
  • max_depth: when Some(d), discovers all nodes within d hops of a seed (boundary nodes are counted but not enqueued past the depth cap). When None, expansion is unbounded by depth (still capped by result_limit).

Fields§

§result_limit: NonZeroUsize

Maximum nodes returned (each seed counts toward the cap).

§max_depth: Option<NonZeroU32>

None = unlimited hops; Some(d) discovers nodes within d hops of a seed.

Implementations§

Source§

impl TraverseLimits

Source

pub const fn bounded(result_limit: NonZeroUsize) -> Self

Creates limits with only a result cap.

§Performance

This method is O(1).

Source

pub fn capped_by(self, config: &Config) -> Result<Self, PostgresGraphError>

Applies configured traverse cap from config.

§Errors

Returns PostgresGraphError::Query when the capped limit is zero.

§Performance

This method is O(1).

Trait Implementations§

Source§

impl Clone for TraverseLimits

Source§

fn clone(&self) -> TraverseLimits

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 Copy for TraverseLimits

Source§

impl Debug for TraverseLimits

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for TraverseLimits

Source§

impl PartialEq for TraverseLimits

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TraverseLimits

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.