Enum Area 

#[non_exhaustive]
pub enum Area {
    BoundingBox {
        south_west: GeoPoint,
        north_east: GeoPoint,
    },
    PointRadius {
        center: GeoPoint,
        radius_nm: f64,
    },
    LocationRadius {
        ident: String,
        radius_nm: f64,
    },
    Polygon {
        vertices: Vec<GeoPoint>,
    },
}

The geographic area a briefing covers.

Not every source supports every shape natively; adapters either convert (a point radius encloses a bounding box and vice versa) or return crate::ProviderError::Unsupported.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

BoundingBox

Axis-aligned bounding box.

Fields

south_west: GeoPoint

South-west corner.

north_east: GeoPoint

North-east corner.

PointRadius

Circle of radius_nm nautical miles around a coordinate.

Fields

center: GeoPoint

Circle center.

radius_nm: f64

Radius in nautical miles.

LocationRadius

Circle of radius_nm nautical miles around a published location (ICAO/FAA aerodrome, navaid or fix identifier).

Fields

ident: String

Location identifier, e.g. "KSFO".

radius_nm: f64

Radius in nautical miles.

Polygon

A polygon over vertices, treated as an implicitly closed ring (the last vertex connects back to the first). Vertex order may be either winding; self-intersecting rings give ray-cast semantics.

Fields

vertices: Vec<GeoPoint>

Ring vertices, at least three.

Implementations

impl Area

pub fn enclosing_bbox(&self) -> Option<(GeoPoint, GeoPoint)>

Smallest axis-aligned bounding box enclosing this area, as (south_west, north_east), when one can be computed without a location database.

Returns None for areas anchored to a published identifier; only the provider can resolve those. The radius conversion uses the small-area approximation (1 NM of latitude = 1/60 degree) and is not meaningful within a radius of the poles.

pub fn contains(&self, point: GeoPoint) -> Option<bool>

Whether the area contains point, when that is decidable without a location database: None for Area::LocationRadius (mirroring the Self::enclosing_bbox contract), Some otherwise. This is the spatial-association hook TFR/NOTAM/weather modules filter geo-referenced products with.

Trait Implementations

impl Clone for Area

fn clone(&self) -> Area

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Area

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Area

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Area

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Area

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 Area