Skip to main content

RouteOptions

oxigdal_algorithms::vector::network

Struct RouteOptions

pub struct RouteOptions {
    pub algorithm: RoutingAlgorithm,
    pub turn_restrictions: Vec<TurnRestriction>,
    pub avoid_tolls: bool,
    pub avoid_highways: bool,
    pub max_detour_factor: Option<f64>,
    pub criteria: RoutingCriteria,
    pub turn_penalties: Option<TurnPenalties>,
    pub alternatives: usize,
    pub alternative_overlap_threshold: f64,
    pub via_points: Vec<NodeId>,
}

Expand description

Routing options

Fields§

§algorithm: RoutingAlgorithm

Routing algorithm

§turn_restrictions: Vec<TurnRestriction>

Turn restrictions

§avoid_tolls: bool

Avoid toll roads

§avoid_highways: bool

Avoid highways

§max_detour_factor: Option<f64>

Maximum detour factor (e.g., 1.2 = 20% longer than straight line)

§criteria: RoutingCriteria

Multi-criteria routing weights

§turn_penalties: Option<TurnPenalties>

Turn penalties

§alternatives: usize

Number of alternative routes to generate

§alternative_overlap_threshold: f64

Alternative route overlap threshold (0.0 to 1.0, lower = more distinct)

§via_points: Vec<NodeId>

Via points (mandatory intermediate stops, in order)

Trait Implementations§

impl Clone for RouteOptions

fn clone(&self) -> RouteOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for RouteOptions

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

Formats the value using the given formatter. Read more

impl Default for RouteOptions

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl Freeze for RouteOptions

impl RefUnwindSafe for RouteOptions

impl Send for RouteOptions

impl Sync for RouteOptions

impl Unpin for RouteOptions

impl UnsafeUnpin for RouteOptions

impl UnwindSafe for RouteOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.