Enum libosmium::Area

pub enum Area {}

An area, as the name suggests, is some mapped area with tags.

Way or Relation?

An “area” is actually not a type of object defined by osm. It is more like a meta object. In osm an “area” is ether a single way or a relation of ways with appropriated tags.

Use is_from_way to check what a given area is actually saved as and original_id to get the underlying object’s is.

Multipolygon

A multipolygon consists of multiple polygons named “outer rings” which contain “inner rings”. These are polygons as well, which are “cut out” from their outer ring. Use outer_rings and inner_rings to access the area’s rings.

Each ring i.e. polygon is just a list of points.

While the general shape of an area is a multipolygon, most areas are just a single outer ring without any inner ones. For example most residential buildings are just a single polygon. Use is_multipolygon and num_rings to check an area’s shape.

Implementations

impl Area

pub fn is_from_way(&self) -> bool

Was this area created from a way? (In contrast to areas created from a relation and their members.)

pub fn original_id(&self) -> i64

Return the Id of the way or relation this area was created from.

pub fn num_rings(&self) -> (usize, usize)

Count the number of outer and inner rings of this area.

pub fn is_multipolygon(&self) -> bool

Check whether this area is a multipolygon, ie. whether it has more than one outer ring.

pub fn outer_rings(&self) -> impl Iterator<Item = &OuterRing>

Return an iterator over all outer rings.

pub fn inner_rings<'a>(
    &'a self,
    outer: &'a OuterRing
) -> impl Iterator<Item = &'a InnerRing> + 'a

Return an iterator over all inner rings in the given outer ring.

Methods from Deref<Target = OSMObject>

pub fn id(&self) -> i64

Get ID of this object.

pub fn positive_id(&self) -> u64

Get absolute value of the ID of this object.

pub fn deleted(&self) -> bool

Is this object marked as deleted?

pub fn visible(&self) -> bool

Is this object marked visible (ie not deleted)?

pub fn version(&self) -> u32

Get version of this object.

pub fn uid(&self) -> u32

Get user id of this object.

pub fn user_is_anonymous(&self) -> bool

Is this user anonymous?

pub fn timestamp(&self) -> u32

Get timestamp when this object last changed.

pub fn user(&self) -> &CStr

Get user name for this object.

pub fn tags(&self) -> &TagList

Get the list of tags for this object.

Trait Implementations

impl AsMut<Item> for Area

fn as_mut(&mut self) -> &mut Item

Cast to an crate::item::Item reference

impl AsMut<OSMObject> for Area

fn as_mut(&mut self) -> &mut OSMObject

Cast to an crate::object::OSMObject reference

impl AsRef<Item> for Area

fn as_ref(&self) -> &Item

Cast to an crate::item::Item reference

impl AsRef<OSMObject> for Area

fn as_ref(&self) -> &OSMObject

Cast to an crate::object::OSMObject reference

impl Deref for Area

fn deref(&self) -> &Self::Target

Cast to an [$crate :: object :: OSMObject] reference

type Target = OSMObject

The resulting type after dereferencing.

impl DerefMut for Area

fn deref_mut(&mut self) -> &mut Self::Target

Cast to an [$crate :: object :: OSMObject] reference