Struct MultiPointBuilder

pub struct MultiPointBuilder { /* private fields */ }

The GeoArrow equivalent to Vec<Option<MultiPoint>>: a mutable collection of MultiPoints.

Converting an MultiPointBuilder into a MultiPointArray is O(1).

Implementations

impl MultiPointBuilder

pub fn new(typ: MultiPointType) -> Self

Creates a new empty MultiPointBuilder.

pub fn with_capacity(typ: MultiPointType, capacity: MultiPointCapacity) -> Self

Creates a new MultiPointBuilder with a capacity.

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

Reserves capacity for at least additional more MultiPoints.

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: MultiPointCapacity)

Reserves the minimum capacity for at least additional more MultiPoints.

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

Consume the builder and convert to an immutable MultiPointArray

pub fn extend_from_iter<'a>( &mut self, geoms: impl Iterator<Item = Option<&'a (impl MultiPointTrait<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 push_point( &mut self, value: Option<&impl PointTrait<T = f64>>, ) -> GeoArrowResult<()>

Add a new Point to the end of this array.

Errors

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

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

Add a new MultiPoint to the end of this array.

Errors

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

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 Point or MultiPoint.

pub fn from_multi_points( geoms: &[impl MultiPointTrait<T = f64>], typ: MultiPointType, ) -> Self

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

pub fn from_nullable_multi_points( geoms: &[Option<impl MultiPointTrait<T = f64>>], typ: MultiPointType, ) -> Self

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

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

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

Trait Implementations

impl Debug for MultiPointBuilder

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, MultiPointType)> for MultiPointBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.