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 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<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.