Struct street_network::LaneSpec

pub struct LaneSpec {
    pub lt: LaneType,
    pub dir: Direction,
    pub width: Distance,
}

Fields

lt: LaneType

dir: Direction

width: Distance

Implementations

impl LaneSpec

pub fn maybe_add_bike_lanes(
    lanes_ltr: &mut Vec<LaneSpec>,
    buffer_type: Option<BufferType>,
    driving_side: DrivingSide
)

impl LaneSpec

pub fn add_new_lane(
    lanes_ltr: &mut Vec<LaneSpec>,
    lt: LaneType,
    osm_tags: &Tags,
    driving_side: DrivingSide
) -> usize

Returns the index where the new lane was inserted

impl LaneSpec

pub fn toggle_road_direction(
    lanes_ltr: &mut Vec<LaneSpec>,
    driving_side: DrivingSide
)

Convert the driving lanes of a road between one-way forwards, one-way backwards, and bidirectional. It should be idempotent to apply this 3 times in a row. Even when an existing one-way street is narrow, it can be made bidirectional by splitting into two very narrow lanes.

impl LaneSpec

pub fn create_for_test(input_lt: &str, input_dir: &str) -> Vec<LaneSpec>

Transforms a string describing lane types and directions, like “spddps” and “vv^^^^^”, into a list of LaneSpecs. Useful for unit tests.

pub fn check_lanes_ltr(
    actual_lanes_ltr: &[LaneSpec],
    description: String,
    input_lt: &str,
    input_dir: &str,
    expected_lt: &str,
    expected_dir: &str,
    ok: &mut bool
)

This is meant for table-driven unit tests. Call this on the transformed / output lanes. If the lanes don’t match, ok will be set to false and appropriate errors will be printed.

impl LaneSpec

pub fn typical_lane_widths(
    lt: LaneType,
    tags: &Tags
) -> Vec<(Distance, &'static str)>

For a given lane type, returns some likely widths. This may depend on the type of the road, so the OSM tags are also passed in. The first value returned will be used as a default.

pub(crate) fn assemble_ltr(
    fwd_side: Vec<LaneSpec>,
    back_side: Vec<LaneSpec>,
    driving_side: DrivingSide
) -> Vec<LaneSpec>

Put a list of forward and backward lanes into left-to-right order, depending on the driving side. Both input lists should be ordered from the center of the road going outwards.

pub fn oneway_for_driving(lanes: &[LaneSpec]) -> Option<Direction>

None if bidirectional. If it’s one-way, which direction is that relative to the road? (Usually forwards)

Trait Implementations

impl Clone for LaneSpec

fn clone(&self) -> LaneSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LaneSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LaneSpec

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<LaneSpec> for LaneSpec

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

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

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

This method tests for !=.

impl Serialize for LaneSpec

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LaneSpec