Struct GeometryCollectionBuilder

pub struct GeometryCollectionBuilder { /* private fields */ }

The GeoArrow equivalent to Vec<Option<GeometryCollection>>: a mutable collection of GeometryCollections.

Converting an GeometryCollectionBuilder into a GeometryCollectionArray is O(1).

Implementations

impl<'a> GeometryCollectionBuilder

pub fn new(typ: GeometryCollectionType) -> Self

Creates a new empty GeometryCollectionBuilder.

pub fn with_capacity( typ: GeometryCollectionType, capacity: GeometryCollectionCapacity, ) -> Self

Creates a new empty GeometryCollectionBuilder with the provided capacity.

pub fn with_prefer_multi(self, prefer_multi: bool) -> Self

Change whether to prefer multi or single arrays for new single-part geometries.

If true, a new Point will be added to the MultiPointBuilder child array, a new LineString will be added to the MultiLineStringBuilder child array, and a new Polygon will be added to the MultiPolygonBuilder child array.

This can be desired when the user wants to downcast the array to a single geometry array later, as casting to a, say, MultiPointArray from a GeometryCollectionArray could be done zero-copy.

Note that only geometries added after this method is called will be affected.

pub fn reserve(&mut self, additional: GeometryCollectionCapacity)

Reserves capacity for at least additional more GeometryCollections.

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, additional: GeometryCollectionCapacity)

Reserves the minimum capacity for at least additional more GeometryCollections.

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) -> GeometryCollectionArray

Consume the builder and convert to an immutable GeometryCollectionArray

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

Push a Geometry onto the end of this builder

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

Push a GeometryCollection onto the end of this builder

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

Extend this builder with the given geometries

pub fn from_geometry_collections( geoms: &[impl GeometryCollectionTrait<T = f64>], typ: GeometryCollectionType, ) -> GeoArrowResult<Self>

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

pub fn from_nullable_geometry_collections( geoms: &[Option<impl GeometryCollectionTrait<T = f64>>], typ: GeometryCollectionType, ) -> GeoArrowResult<Self>

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

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

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

Trait Implementations

impl Debug for GeometryCollectionBuilder

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, GeometryCollectionType)> for GeometryCollectionBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.