Struct PolygonBuilder

pub struct PolygonBuilder { /* private fields */ }

The GeoArrow equivalent to Vec<Option<Polygon>>: a mutable collection of Polygons.

Converting an PolygonBuilder into a PolygonArray is O(1).

Implementations

impl PolygonBuilder

pub fn new(typ: PolygonType) -> Self

Creates a new empty PolygonBuilder.

pub fn with_capacity(typ: PolygonType, capacity: PolygonCapacity) -> Self

Creates a new PolygonBuilder with given capacity and no validity.

pub fn reserve(&mut self, capacity: PolygonCapacity)

Reserves capacity for at least additional more Polygons.

The collection may reserve more space to speculatively avoid frequent reallocations. After calling reserve, capacity will be greater than or equal to self.len() + additional. Does nothing if capacity is already sufficient.

pub fn reserve_exact(&mut self, capacity: PolygonCapacity)

Reserves the minimum capacity for at least additional more Polygons.

Unlike reserve, this will not deliberately over-allocate to speculatively avoid frequent allocations. After calling reserve_exact, capacity will be greater than or equal to self.len() + additional. Does nothing if the capacity is already sufficient.

Note that the allocator may give the collection more space than it requests. Therefore, capacity can not be relied upon to be precisely minimal. Prefer reserve if future insertions are expected.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of self to fit.

pub fn finish(self) -> PolygonArray

Consume the builder and convert to an immutable PolygonArray

pub fn push_polygon( &mut self, value: Option<&impl PolygonTrait<T = f64>>, ) -> GeoArrowResult<()>

Add a new Polygon to the end of this array.

Errors

This function errors iff the new last item is larger than what O supports.

pub fn push_rect( &mut self, value: Option<&impl RectTrait<T = f64>>, ) -> GeoArrowResult<()>

Add a new Rect to this builder

pub fn push_geometry( &mut self, value: Option<&impl GeometryTrait<T = f64>>, ) -> GeoArrowResult<()>

Add a new geometry to this builder

This will error if the geometry type is not Polygon, a MultiPolygon of length 1, or Rect.

pub fn extend_from_iter<'a>( &mut self, geoms: impl Iterator<Item = Option<&'a (impl PolygonTrait<T = f64> + 'a)>>, )

Extend this builder with the given geometries

pub fn extend_from_geometry_iter<'a>( &mut self, geoms: impl Iterator<Item = Option<&'a (impl GeometryTrait<T = f64> + 'a)>>, ) -> GeoArrowResult<()>

Extend this builder with the given geometries

pub fn from_polygons( geoms: &[impl PolygonTrait<T = f64>], typ: PolygonType, ) -> Self

Construct a new builder, pre-filling it with the provided geometries

pub fn from_nullable_polygons( geoms: &[Option<impl PolygonTrait<T = f64>>], typ: PolygonType, ) -> Self

Construct a new builder, pre-filling it with the provided geometries

pub fn from_nullable_geometries( geoms: &[Option<impl GeometryTrait<T = f64>>], typ: PolygonType, ) -> GeoArrowResult<Self>

Construct a new builder, pre-filling it with the provided geometries

Trait Implementations

impl Debug for PolygonBuilder

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

Formats the value using the given formatter.

impl GeomProcessor for PolygonBuilder

Available on crate feature geozero only.

fn geometrycollection_begin(&mut self, size: usize, idx: usize) -> Result<()>

Begin of GeometryCollection processing

fn geometrycollection_end(&mut self, idx: usize) -> Result<()>

End of GeometryCollection processing

fn xy(&mut self, x: f64, y: f64, idx: usize) -> Result<()>

Process coordinate with x,y dimensions

fn coordinate( &mut self, x: f64, y: f64, z: Option<f64>, m: Option<f64>, t: Option<f64>, tm: Option<u64>, idx: usize, ) -> Result<()>

Process coordinate with all requested dimensions

fn polygon_begin(&mut self, tagged: bool, size: usize, idx: usize) -> Result<()>

Begin of Polygon processing

fn linestring_begin( &mut self, tagged: bool, size: usize, idx: usize, ) -> Result<()>

Begin of LineString processing

fn dimensions(&self) -> CoordDimensions

Additional dimensions requested when processing coordinates

fn multi_dim(&self) -> bool

Request additional dimensions for coordinate processing

fn srid(&mut self, srid: Option<i32>) -> Result<(), GeozeroError>

SRID of geometries

fn empty_point(&mut self, idx: usize) -> Result<(), GeozeroError>

Process empty coordinates, like WKT’s POINT EMPTY

fn point_begin(&mut self, idx: usize) -> Result<(), GeozeroError>

Begin of Point processing

fn point_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of Point processing

fn multipoint_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of MultiPoint processing

fn multipoint_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiPoint processing

fn linestring_end( &mut self, tagged: bool, idx: usize, ) -> Result<(), GeozeroError>

End of LineString processing

fn multilinestring_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of MultiLineString processing

fn multilinestring_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiLineString processing

fn polygon_end(&mut self, tagged: bool, idx: usize) -> Result<(), GeozeroError>

End of Polygon processing

fn multipolygon_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of MultiPolygon processing

fn multipolygon_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiPolygon processing

fn circularstring_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of CircularString processing

fn circularstring_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of CircularString processing

fn compoundcurve_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of CompoundCurve processing

fn compoundcurve_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of CompoundCurve processing

fn curvepolygon_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of CurvePolygon processing

fn curvepolygon_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of CurvePolygon processing

fn multicurve_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of MultiCurve processing

fn multicurve_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiCurve processing

fn multisurface_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of MultiSurface processing

fn multisurface_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiSurface processing

fn triangle_begin( &mut self, tagged: bool, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of Triangle processing

fn triangle_end(&mut self, tagged: bool, idx: usize) -> Result<(), GeozeroError>

End of Triangle processing

fn polyhedralsurface_begin( &mut self, size: usize, idx: usize, ) -> Result<(), GeozeroError>

Begin of PolyhedralSurface processing

fn polyhedralsurface_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of PolyhedralSurface processing

fn tin_begin(&mut self, size: usize, idx: usize) -> Result<(), GeozeroError>

Begin of Tin processing

fn tin_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of Tin processing

fn pre_process_xy<F>(self, transform_xy: F) -> WrappedXYProcessor<Self, F>

where F: Fn(&mut f64, &mut f64), Self: Sized,

Combinator which inserts a call to transform_xy during processing, before GeomProcessor::xy or GeomProcessor::coordinate is called.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, PolygonType)> for PolygonBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from( (value, typ): (GenericWkbArray<O>, PolygonType), ) -> GeoArrowResult<Self>

Performs the conversion.