Struct map_model::edits::MapEdits

pub struct MapEdits {
    pub edits_name: String,
    pub commands: Vec<EditCmd>,
    pub merge_zones: bool,
    pub changed_roads: BTreeSet<RoadID>,
    pub original_intersections: BTreeMap<IntersectionID, EditIntersection>,
    pub changed_routes: BTreeSet<BusRouteID>,
    pub proposal_description: Vec<String>,
    pub proposal_link: Option<String>,
}

Represents changes to a map. Note this isn’t serializable – that’s what PermanentMapEdits does.

Fields

edits_name: String

commands: Vec<EditCmd>

A stack, oldest edit is first. The same intersection may be edited multiple times in this stack, until compress() happens.

merge_zones: bool

If false, adjacent roads with the same AccessRestrictions will not be merged into the same Zone; every Road will be its own Zone. This is used to experiment with a per-road cap. Note this is a map-wide setting.

changed_roads: BTreeSet<RoadID>

Derived from commands, kept up to date by update_derived

original_intersections: BTreeMap<IntersectionID, EditIntersection>

changed_routes: BTreeSet<BusRouteID>

proposal_description: Vec<String>

Some edits are included in the game by default, in data/system/proposals, as “community proposals.” They require a description and may have a link to a write-up.

proposal_link: Option<String>

Implementations

impl MapEdits

pub fn to_permanent(&self, map: &Map) -> PermanentMapEdits

Encode the edits in a permanent format, referring to more-stable OSM IDs.

impl MapEdits

pub(crate) fn new() -> MapEdits

pub fn load_from_file(
    map: &Map,
    path: String,
    timer: &mut Timer<'_>
) -> Result<MapEdits>

Load map edits from a JSON file. If any part of the edits don’t match the current map, fail.

pub fn load_from_bytes(map: &Map, bytes: Vec<u8>) -> Result<MapEdits>

Load map edits from the given JSON bytes. If any part of the edits don’t match the current map, fail.

pub fn load_from_file_permissive(
    map: &Map,
    path: String,
    timer: &mut Timer<'_>
) -> Result<MapEdits>

Load map edits from a JSON file. Strip out any commands that’re broken because they don’t match the current map. If the resulting edits are totally empty, consider that a failure – the edits likely don’t cover this map at all. This is currently most appropriate when using system proposals that cover a large area.

fn save(&self, map: &Map)

fn update_derived(&mut self, map: &Map)

pub fn compress(&mut self, map: &Map)

Assumes update_derived has been called.

pub fn changed_lanes(&self, map: &Map) -> (BTreeSet<LaneID>, BTreeSet<RoadID>)

Pick apart changed_roads and figure out if an entire road was edited, or just a few lanes. Doesn’t return deleted lanes.

pub fn get_checksum(&self, map: &Map) -> String

Produces an md5sum of the contents of the edits.

pub fn get_title(&self) -> &str

Get the human-friendly of these edits. If they have a descrption, the first line is the title. Otherwise we use the filename.

Trait Implementations

impl Clone for MapEdits

fn clone(&self) -> MapEdits

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MapEdits

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

Formats the value using the given formatter.

impl Default for MapEdits

fn default() -> MapEdits

Returns the “default value” for a type.

impl PartialEq<MapEdits> for MapEdits

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

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

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

This method tests for !=.

impl StructuralPartialEq for MapEdits