Struct map_model::pathfind::v1::PathRequest

pub struct PathRequest {
    pub start: Position,
    pub end: Position,
    pub constraints: PathConstraints,
    pub(crate) alt_start: Option<(Position, Duration)>,
}

Fields

start: Position

end: Position

constraints: PathConstraints

alt_start: Option<(Position, Duration)>

Implementations

impl PathRequest

pub fn between_buildings(
    map: &Map,
    from: BuildingID,
    to: BuildingID,
    constraints: PathConstraints
) -> Option<PathRequest>

Determines the start and end position to travel between two buildings for a certain mode. The path won’t cover modality transfers – if somebody has to walk between the building and a parking spot or bikeable position, that won’t be captured here.

pub fn walking(start: Position, end: Position) -> PathRequest

The caller must pass in two valid sidewalk positions. This isn’t verified.

pub fn vehicle(
    start: Position,
    end: Position,
    constraints: PathConstraints
) -> PathRequest

The caller must pass in two valid positions for the vehicle type. This isn’t verified. No off-side turns from driveways happen; the exact start position is used.

pub fn leave_from_driveway(
    start: Position,
    end: Position,
    constraints: PathConstraints,
    map: &Map
) -> PathRequest

The caller must pass in two valid positions for the vehicle type. This isn’t verified. TODO The vehicle may cut exit the driveway onto the off-side of the road.

pub fn between_directed_roads(
    map: &Map,
    from: DirectedRoadID,
    to: DirectedRoadID,
    constraints: PathConstraints
) -> Option<PathRequest>

Create a request from the beginning of one road to the end of another. Picks an arbitrary start and end lane from the available ones.

pub fn deduplicate(
    map: &Map,
    requests: Vec<PathRequest>
) -> Vec<(PathRequest, usize)>

Group similar requests together, returning the number of matches. This can be used to calculate less paths and multiply whatever’s being measured by the count.

Note this throws away detail. It only groups by the mode and from/to parent. Exact position and alternate starting points are lost.

Trait Implementations

impl Clone for PathRequest

fn clone(&self) -> PathRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for PathRequest

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

Formats the value using the given formatter.

impl PartialEq<PathRequest> for PathRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for PathRequest

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

Serialize this value into the given Serde serializer.

impl Eq for PathRequest

impl StructuralEq for PathRequest

impl StructuralPartialEq for PathRequest