Struct geoarrow::array::PointBuilder

pub struct PointBuilder {
    pub coords: CoordBufferBuilder,
    pub validity: NullBufferBuilder,
    /* private fields */
}

The GeoArrow equivalent to Vec<Option<Point>>: a mutable collection of Points.

Converting an PointBuilder into a PointArray is O(1).

Fields

coords: CoordBufferBuilder

validity: NullBufferBuilder

Implementations

impl PointBuilder

pub fn new() -> Self

Creates a new empty PointBuilder.

pub fn new_with_options( coord_type: CoordType, metadata: Arc<ArrayMetadata> ) -> Self

pub fn with_capacity(capacity: usize) -> Self

Creates a new PointBuilder with a capacity.

pub fn with_capacity_and_options( capacity: usize, coord_type: CoordType, metadata: Arc<ArrayMetadata> ) -> Self

Creates a new PointBuilder with a capacity.

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

Reserves capacity for at least additional more points to be inserted in the given Vec<T>. 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: usize)

Reserves the minimum capacity for at least additional more points to be inserted in the given Vec<T>. 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 try_new( coords: CoordBufferBuilder, validity: NullBufferBuilder, metadata: Arc<ArrayMetadata> ) -> Result<Self>

The canonical method to create a PointBuilder out of its internal components.

Implementation

This function is O(1).

Errors

This function errors iff:

• The validity is not None and its length is different from the number of geometries

pub fn into_inner(self) -> (CoordBufferBuilder, NullBufferBuilder)

Extract the low-level APIs from the PointBuilder.

pub fn push_point(&mut self, value: Option<&impl PointTrait<T = f64>>)

Add a new point to the end of this array.

pub fn push_empty(&mut self)

Add a valid but empty point to the end of this array.

pub fn push_null(&mut self)

Add a new null value to the end of this array.

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

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

pub fn from_points<'a>( geoms: impl ExactSizeIterator + Iterator<Item = &'a (impl PointTrait<T = f64> + 'a)>, coord_type: Option<CoordType>, metadata: Arc<ArrayMetadata> ) -> Self

pub fn from_nullable_points<'a>( geoms: impl ExactSizeIterator + Iterator<Item = Option<&'a (impl PointTrait<T = f64> + 'a)>>, coord_type: Option<CoordType>, metadata: Arc<ArrayMetadata> ) -> Self

pub fn finish(self) -> PointArray

Trait Implementations

impl Debug for PointBuilder

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

Formats the value using the given formatter.

impl Default for PointBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<G: PointTrait<T = f64>> From<&[G]> for PointBuilder

fn from(value: &[G]) -> Self

Converts to this type from the input type.

impl From<PointBuilder> for Arc<dyn Array>

fn from(arr: PointBuilder) -> Self

Converts to this type from the input type.

impl From<PointBuilder> for PointArray

fn from(other: PointBuilder) -> Self

Converts to this type from the input type.

impl<G: PointTrait<T = f64>> From<Vec<'_, G>> for PointBuilder

fn from(geoms: Vec<'_, G>) -> Self

Converts to this type from the input type.

impl<G: PointTrait<T = f64>> From<Vec<'_, Option<G>>> for PointBuilder

fn from(geoms: Vec<'_, Option<G>>) -> Self

Converts to this type from the input type.

impl<G: PointTrait<T = f64>> From<Vec<Option<G>>> for PointBuilder

fn from(geoms: Vec<Option<G>>) -> Self

Converts to this type from the input type.

impl GeomProcessor for PointBuilder

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

Process empty coordinates, like WKT’s POINT EMPTY

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

Process coordinate with x,y dimensions

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

Begin of GeometryCollection processing

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

Begin of CircularString processing

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

Begin of CompoundCurve processing

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

Begin of Tin processing

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

Begin of Polygon processing

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

Begin of Triangle processing

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

Begin of LineString processing

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

Begin of MultiPoint processing

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

Begin of CurvePolygon processing

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

Begin of MultiPolygon processing

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

Begin of MultiSurface processing

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

Begin of MultiLineString processing

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

Begin of PolyhedralSurface 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 coordinate( &mut self, x: f64, y: f64, z: Option<f64>, m: Option<f64>, t: Option<f64>, tm: Option<u64>, idx: usize ) -> Result<(), GeozeroError>

Process coordinate with all requested dimensions

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_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_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_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiPolygon processing

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

End of GeometryCollection processing

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

End of CircularString processing

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

End of CompoundCurve 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_end(&mut self, idx: usize) -> Result<(), GeozeroError>

End of MultiSurface processing

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

End of Triangle processing

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

End of PolyhedralSurface processing

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

End of Tin processing

impl GeometryArrayBuilder for PointBuilder

fn new() -> Self

fn with_geom_capacity_and_options( geom_capacity: usize, coord_type: CoordType, metadata: Arc<ArrayMetadata> ) -> Self

fn set_metadata(&mut self, metadata: Arc<ArrayMetadata>)

fn finish(self) -> Arc<dyn GeometryArrayTrait>

fn len(&self) -> usize

The length of the array.

fn validity(&self) -> &NullBufferBuilder

The optional validity of the array.

fn into_array_ref(self) -> Arc<dyn Array>

fn coord_type(&self) -> CoordType

Get the coordinate type of this geometry array, either interleaved or separated.

fn metadata(&self) -> Arc<ArrayMetadata>

fn is_empty(&self) -> bool

Whether the array is empty.

fn with_geom_capacity(geom_capacity: usize) -> Self

impl IntoArrow for PointBuilder

type ArrowArray = Arc<dyn Array>

fn into_arrow(self) -> Self::ArrowArray

impl<'a> TryFrom<Vec<Option<Geometry<'a>>>> for PointBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: Vec<Option<Geometry<'a>>>) -> Result<Self, Self::Error>

Performs the conversion.

impl<O: OffsetSizeTrait> TryFrom<WKBArray<O>> for PointBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: WKBArray<O>) -> Result<Self>

Performs the conversion.