Struct LineStringBuilder

pub struct LineStringBuilder { /* private fields */ }

The GeoArrow equivalent to Vec<Option<LineString>>: a mutable collection of LineStrings.

Converting an LineStringBuilder into a LineStringArray is O(1).

Implementations

impl LineStringBuilder

pub fn new(typ: LineStringType) -> Self

Creates a new empty LineStringBuilder.

pub fn with_capacity(typ: LineStringType, capacity: LineStringCapacity) -> Self

Creates a new LineStringBuilder with a capacity.

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

Reserves capacity for at least additional more LineStrings.

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

Reserves the minimum capacity for at least additional more LineStrings.

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 push_empty(&mut self)

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

pub fn finish(self) -> LineStringArray

Consume the builder and convert to an immutable LineStringArray

pub fn from_line_strings( geoms: &[impl LineStringTrait<T = f64>], typ: LineStringType, ) -> Self

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

pub fn from_nullable_line_strings( geoms: &[Option<impl LineStringTrait<T = f64>>], typ: LineStringType, ) -> Self

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

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

Add a new LineString to the end of this array.

Errors

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

pub fn extend_from_iter<'a>( &mut self, geoms: impl Iterator<Item = Option<&'a (impl LineStringTrait<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_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 LineString or a MultiLineString with length 1.

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

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

Trait Implementations

impl Debug for LineStringBuilder

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, LineStringType)> for LineStringBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.