Struct MutablePolygonArray

pub struct MutablePolygonArray<O: OffsetSizeTrait> { /* private fields */ }

The Arrow equivalent to Vec<Option<Polygon>>. Converting a MutablePolygonArray into a PolygonArray is O(1).

Implementations

impl<O: OffsetSizeTrait> MutablePolygonArray<O>

pub fn new() -> Self

Creates a new empty MutablePolygonArray.

pub fn with_capacities( coord_capacity: usize, ring_capacity: usize, geom_capacity: usize, ) -> Self

Creates a new MutablePolygonArray with given capacities and no validity.

pub fn reserve( &mut self, coord_additional: usize, ring_additional: usize, geom_additional: usize, )

Reserves capacity for at least additional more LineStrings 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, coord_additional: usize, ring_additional: usize, geom_additional: usize, )

Reserves the minimum capacity for at least additional more LineStrings 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: MutableCoordBuffer, geom_offsets: OffsetsBuilder<O>, ring_offsets: OffsetsBuilder<O>, validity: NullBufferBuilder, ) -> Result<Self>

The canonical method to create a MutablePolygonArray 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 into_inner( self, ) -> (MutableCoordBuffer, OffsetsBuilder<O>, OffsetsBuilder<O>, NullBufferBuilder)

Extract the low-level APIs from the MutablePolygonArray.

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

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

Add a new Polygon to the end of this array.

Errors

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

pub unsafe fn try_push_geom_offset( &mut self, offsets_length: usize, ) -> Result<()>

Push a raw offset to the underlying geometry offsets buffer.

Safety

This is marked as unsafe because care must be taken to ensure that pushing raw offsets upholds the necessary invariants of the array.

pub unsafe fn try_push_ring_offset( &mut self, offsets_length: usize, ) -> Result<()>

Push a raw offset to the underlying ring offsets buffer.

Safety

This is marked as unsafe because care must be taken to ensure that pushing raw offsets upholds the necessary invariants of the array.

pub unsafe fn push_xy(&mut self, x: f64, y: f64) -> Result<()>

Push a raw coordinate to the underlying coordinate array.

Safety

This is marked as unsafe because care must be taken to ensure that pushing raw coordinates to the array upholds the necessary invariants of the array.

Trait Implementations

impl<O: Debug + OffsetSizeTrait> Debug for MutablePolygonArray<O>

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> Default for MutablePolygonArray<O>

fn default() -> Self

Returns the “default value” for a type.

impl<O: OffsetSizeTrait> From<MutableMultiLineStringArray<O>> for MutablePolygonArray<O>

Polygon and MultiLineString have the same layout, so enable conversions between the two to change the semantic type

fn from(value: MutableMultiLineStringArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<MutablePolygonArray<O>> for MutableMultiLineStringArray<O>

Polygon and MultiLineString have the same layout, so enable conversions between the two to change the semantic type

fn from(value: MutablePolygonArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<MutablePolygonArray<O>> for PolygonArray<O>

fn from(other: MutablePolygonArray<O>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait, G: PolygonTrait<T = f64>> From<Vec<'_, G>> for MutablePolygonArray<O>

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

Converts to this type from the input type.

impl<O: OffsetSizeTrait, G: PolygonTrait<T = f64>> From<Vec<'_, Option<G>>> for MutablePolygonArray<O>

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

Converts to this type from the input type.

impl<O: OffsetSizeTrait, G: PolygonTrait<T = f64>> From<Vec<G>> for MutablePolygonArray<O>

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

Converts to this type from the input type.

impl<O: OffsetSizeTrait, G: PolygonTrait<T = f64>> From<Vec<Option<G>>> for MutablePolygonArray<O>

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

Converts to this type from the input type.

impl<O: OffsetSizeTrait> IntoArrow for MutablePolygonArray<O>

type ArrowArray = GenericListArray<O>

fn into_arrow(self) -> Self::ArrowArray

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

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.