Struct CatchmentUnit 

pub struct CatchmentUnit { /* private fields */ }

A single drainage unit in an HFX dataset.

Every field is validated at construction time via the primitive newtypes (UnitId, Level, AreaKm2, OutletCoord, BoundingBox, WkbGeometry); CatchmentUnit itself performs no additional validation.

Implementations

impl CatchmentUnit

pub fn new( id: UnitId, level: Level, parent_id: Option<UnitId>, area: AreaKm2, upstream_area: Option<AreaKm2>, outlet: OutletCoord, bbox: BoundingBox, geometry: WkbGeometry, source_id: Option<String>, level_label: Option<String>, ) -> Self

Construct a CatchmentUnit from its constituent validated fields.

All arguments are already domain-typed, so no further validation is performed here — invalid states are unrepresentable by construction.

pub fn id(&self) -> UnitId

Return the unit’s unique identifier.

pub fn level(&self) -> Level

Return the dataset-local level of this unit.

pub fn parent_id(&self) -> Option<UnitId>

Return the optional containing coarser unit ID.

pub fn area(&self) -> AreaKm2

Return the local drainage area of this unit in km².

pub fn upstream_area(&self) -> Option<AreaKm2>

Return the total upstream contributing area in km², if known.

None indicates the value is absent in the source hydrofabric.

pub fn outlet(&self) -> OutletCoord

Return the unit outlet coordinate.

pub fn bbox(&self) -> &BoundingBox

Return a reference to the axis-aligned bounding box of the catchment.

pub fn geometry(&self) -> &WkbGeometry

Return a reference to the WKB geometry of the catchment polygon.

pub fn source_id(&self) -> Option<&str>

Return the optional source-fabric identifier.

pub fn level_label(&self) -> Option<&str>

Return the optional source-fabric level label.

Trait Implementations

impl Clone for CatchmentUnit

fn clone(&self) -> CatchmentUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CatchmentUnit

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

Formats the value using the given formatter.

impl HasBbox for CatchmentUnit

fn bbox(&self) -> &BoundingBox

Return a reference to the bounding box.

impl HasUnitId for CatchmentUnit

fn unit_id(&self) -> UnitId

Return the unit identifier.

impl PartialEq for CatchmentUnit

fn eq(&self, other: &CatchmentUnit) -> 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 StructuralPartialEq for CatchmentUnit