Struct ShapeFileReader 

pub struct ShapeFileReader<T: Reader, P: MValueCompatible = Properties> { /* private fields */ }

The Shapefile Reader

Description

Reads data from a shapefile

Implements the FeatureReader trait

Usage

NOTE: It’s recommended to not parse the shapefile directly but instead:

• crate::readers::file::shapefile_from_path
• crate::readers::mmap::shapefile_from_path

This ensures the other files paired with the shapefile are loaded to properly handle the projection and properties data.

Usage

The methods you have access to:

• ShapeFileReader::new: Create a new ShapeFileReader
• ShapeFileReader::get_header: Get the file header data
• ShapeFileReader::iter: Iterate over the features in the shapefile

From Path (Recommended as it will ensure to pull in associated files):

use gistools::{parsers::{FileReader, FeatureReader}, readers::{ShapeFileReader, file::shapefile_from_path}};
use s2json::MValue;
use std::{collections::BTreeMap, path::PathBuf};

let mut path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
path.push("tests/readers/shapefile/fixtures/utf.shp");
let path_str = path.to_str().unwrap();

#[derive(Default, Debug, Clone, MValue, PartialEq)]
struct Props {
    field: String,
}

let shp: ShapeFileReader<FileReader, Props> =
    shapefile_from_path(path_str, BTreeMap::from([("a".into(), "b".into())]));

let features: Vec<_> = shp.iter().collect();
assert_eq!(features.len(), 2);

Links

• https://en.wikipedia.org/wiki/Shapefile

Implementations

impl<T: Reader, P: MValueCompatible> ShapeFileReader<T, P>

pub fn new( reader: T, dbf: Option<DataBaseFile<T, P>>, transform: Option<Transformer>, ) -> ShapeFileReader<T, P>

Create a new Shapefile Reader

pub fn get_header(&self) -> &SHPHeader

Return a reference to the header

Trait Implementations

impl<T: Clone + Reader, P: Clone + MValueCompatible> Clone for ShapeFileReader<T, P>

fn clone(&self) -> ShapeFileReader<T, P>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Reader, P: Debug + MValueCompatible> Debug for ShapeFileReader<T, P>

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

Formats the value using the given formatter.

impl<T: Reader, P: MValueCompatible> FeatureReader<(), P, Map<String, ValueType>> for ShapeFileReader<T, P>

A feature reader trait with a callback-based approach

type FeatureIterator<'a> = ShapefileIterator<'a, T, P> where T: 'a, P: 'a

The Feature Reader should implement an iterator of some kind

fn iter(&self) -> Self::FeatureIterator<'_>

All readers have an iter function that returns a Iterator struct

fn par_iter( &self, pool_size: usize, thread_id: usize, ) -> Self::FeatureIterator<'_>

All readers have a par_iter function that returns a ParallelIterator struct