Struct MultiLineStringBuilder

pub struct MultiLineStringBuilder { /* private fields */ }

The GeoArrow equivalent to Vec<Option<MultiLineString>>: a mutable collection of MultiLineStrings.

Converting an MultiLineStringBuilder into a MultiLineStringArray is O(1).

Implementations

impl MultiLineStringBuilder

pub fn new(typ: MultiLineStringType) -> Self

Creates a new empty MultiLineStringBuilder.

pub fn with_capacity( typ: MultiLineStringType, capacity: MultiLineStringCapacity, ) -> Self

Creates a new MultiLineStringBuilder with a capacity.

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

Reserves capacity for at least additional more MultiLineStrings.

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

Reserves the minimum capacity for at least additional more MultiLineStrings.

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, geom_offsets: OffsetsBuilder<i32>, ring_offsets: OffsetsBuilder<i32>, validity: NullBufferBuilder, data_type: MultiLineStringType, ) -> GeoArrowResult<Self>

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

Implementation

This function is O(1).

Errors

• if the validity is not None and its length is different from the number of geometries
• if the largest ring offset does not match the number of coordinates
• if the largest geometry offset does not match the size of ring offsets

pub fn finish(self) -> MultiLineStringArray

Consume the builder and convert to an immutable MultiLineStringArray

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 push_multi_line_string( &mut self, value: Option<&impl MultiLineStringTrait<T = f64>>, ) -> GeoArrowResult<()>

Add a new MultiLineString 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 LineString or MultiLineString.

pub fn extend_from_iter<'a>( &mut self, geoms: impl Iterator<Item = Option<&'a (impl MultiLineStringTrait<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_multi_line_strings( geoms: &[impl MultiLineStringTrait<T = f64>], typ: MultiLineStringType, ) -> Self

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

pub fn from_nullable_multi_line_strings( geoms: &[Option<impl MultiLineStringTrait<T = f64>>], typ: MultiLineStringType, ) -> Self

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

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

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

Trait Implementations

impl Debug for MultiLineStringBuilder

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, MultiLineStringType)> for MultiLineStringBuilder

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.