Struct SearchFilter 

pub struct SearchFilter { /* private fields */ }

A set of optional filters to exclude candidate edges based on their attribution.

Implementations

impl SearchFilter

pub fn builder() -> Self

Creates a new instance of SearchFilter.

pub fn exclude_tunnel(self, exclude_tunnel: bool) -> Self

Whether to exclude roads marked as tunnels

Default: false

pub fn exclude_bridge(self, exclude_bridge: bool) -> Self

Whether to exclude roads marked as bridges

Default: false

pub fn exclude_toll(self, exclude_toll: bool) -> Self

Whether to exclude toll

Default: false

pub fn exclude_ferry(self, exclude_ferry: bool) -> Self

Whether to exclude ferry

Default: false

pub fn exclude_ramp(self, exclude_ramp: bool) -> Self

Whether to exclude link roads marked as ramps, note that some turn channels are also marked as ramps

Default: false

pub fn exclude_closures(self, exclude_closures: bool) -> Self

Whether to exclude roads considered closed due to live traffic closure.

Note:

• This option cannot be set if the costing option ignore_closures is also specified.
• Ignoring closures at destination and source locations does NOT work for date_time type 0/1 & 2 respectively

Default: true

pub fn min_road_class(self, min_road_class: RoadClass) -> Self

Lowest road class allowed

Default: RoadClass::ServiceOther

pub fn max_road_class(self, max_road_class: RoadClass) -> Self

Highest road class allowed

Default: RoadClass::Motorway

pub fn level(self, level: f32) -> Self

BETA Will only consider edges that are on or traverse the passed floor level.

Sets search_cutoff to a default value of 300 meters if no cutoff value is passed. Additionally, if a search_cutoff is passed, it will be clamped to 1000 meters.

Trait Implementations

impl Clone for SearchFilter

fn clone(&self) -> SearchFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchFilter

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

Formats the value using the given formatter.

impl Default for SearchFilter

fn default() -> SearchFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SearchFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.