Skip to main content

PathsOptions

Struct PathsOptions 

Source
pub struct PathsOptions {
    pub by: PathAlgorithm,
    pub via: Option<String>,
    pub directed: bool,
    pub k: usize,
    pub weight: Option<String>,
    pub capacity_property: Option<String>,
    pub cost_property: Option<String>,
    pub heuristic: Option<String>,
    pub walk_length: Option<usize>,
    pub seed: Option<u64>,
    pub terminal_uuids: Vec<[u8; 16]>,
    pub prize_property: Option<String>,
}
Expand description

Options for GraphForge::paths.

Fields§

§by: PathAlgorithm

Algorithm name (e.g. "dijkstra", "bfs", "max_flow").

§via: Option<String>

Optional relationship type filter.

§directed: bool

Whether to treat edges as directed.

§k: usize

Number of paths to return (e.g. Yen’s k-shortest).

§weight: Option<String>

Optional edge-weight property name.

§capacity_property: Option<String>

Optional graph-native capacity property for flow algorithms.

§cost_property: Option<String>

Required graph-native unit-cost property for min-cost flow algorithms.

§heuristic: Option<String>

Optional node property containing an A* heuristic estimate.

§walk_length: Option<usize>

Maximum number of edge transitions for random-walk paths.

§seed: Option<u64>

Seed for reproducible random-walk paths.

§terminal_uuids: Vec<[u8; 16]>

Canonical resolved terminal UUIDs for explicit multi-terminal algorithms.

§prize_property: Option<String>

Graph-native node property containing prizes for prize-collecting Steiner trees.

Trait Implementations§

Source§

impl Clone for PathsOptions

Source§

fn clone(&self) -> PathsOptions

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 PathsOptions

Source§

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

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

impl Default for PathsOptions

Source§

fn default() -> Self

Returns the “default value” for a type. 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, 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> Same for T

Source§

type Output = T

Should always be Self
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.