Struct flatgeobuf::FgbReader

pub struct FgbReader<'a, R, State = Initial> { /* private fields */ }

FlatGeobuf dataset reader

Implementations

impl<'a, R: Read> FgbReader<'a, R, Initial>

pub fn open(reader: &'a mut R) -> Result<FgbReader<'a, R, Open>>

Open dataset by reading the header information

pub unsafe fn open_unchecked(
    reader: &'a mut R
) -> Result<FgbReader<'a, R, Open>>

Open dataset by reading the header information without FlatBuffers verification

impl<'a, R: Read> FgbReader<'a, R, Open>

pub fn select_all_seq(self) -> Result<FgbReader<'a, R, FeaturesSelected>>

Select all features without using seek.

pub fn select_bbox_seq(
    self,
    min_x: f64,
    min_y: f64,
    max_x: f64,
    max_y: f64
) -> Result<FgbReader<'a, R, FeaturesSelected>>

Select features within a bounding box without using seek.

impl<'a, R: Read + Seek> FgbReader<'a, R, Open>

pub fn select_all(self) -> Result<FgbReader<'a, R, FeaturesSelectedSeek>>

Select all features.

pub fn select_bbox(
    self,
    min_x: f64,
    min_y: f64,
    max_x: f64,
    max_y: f64
) -> Result<FgbReader<'a, R, FeaturesSelectedSeek>>

Select features within a bounding box.

impl<'a, R: Read, State> FgbReader<'a, R, State>

pub fn header(&self) -> Header<'_>

Header information

pub fn features_count(&self) -> Option<usize>

Number of selected features (None for undefined feature count)

impl<'a, R: Read> FgbReader<'a, R, FeaturesSelected>

pub fn cur_feature(&self) -> &FgbFeature

Return current feature

pub fn process_features<W: FeatureProcessor>(
    &mut self,
    out: &mut W
) -> Result<()>

Read and process all selected features

impl<'a, R: Read + Seek> FgbReader<'a, R, FeaturesSelectedSeek>

pub fn cur_feature(&self) -> &FgbFeature

Return current feature

pub fn process_features<W: FeatureProcessor>(
    &mut self,
    out: &mut W
) -> Result<()>

Read and process all selected features

Trait Implementations

impl<'a, R: Read> FallibleStreamingIterator for FgbReader<'a, R, FeaturesSelected>

FallibleStreamingIterator differs from the standard library’s Iterator in two ways:

• each call to next can fail.
• returned FgbFeature is valid until next is called again or FgbReader is reset or finalized.

While these iterators cannot be used with Rust for loops, while let loops offer a similar level of ergonomics:

use flatgeobuf::*;

while let Some(feature) = fgb.next()? {
    let props = feature.properties()?;
    println!("{}", props["name"]);
}

type Error = GeozeroError

The error type of iteration.

type Item = FgbFeature

The type being iterated over.

fn advance(&mut self) -> Result<()>

Advances the iterator to the next position.

fn get(&self) -> Option<&FgbFeature>

Returns the current element.

fn size_hint(&self) -> (usize, Option<usize>)

Returns bounds on the number of remaining elements in the iterator.

fn next(&mut self) -> Result<Option<&Self::Item>, Self::Error>

Advances the iterator, returning the next element.

fn all<F>(&mut self, f: F) -> Result<bool, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Determines if all elements of the iterator satisfy a predicate.

fn any<F>(&mut self, f: F) -> Result<bool, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Determines if any elements of the iterator satisfy a predicate.

fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it.

fn count(self) -> Result<usize, Self::Error>

Returns the number of remaining elements in the iterator.

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Returns an iterator which filters elements by a predicate.

fn find<F>(&mut self, f: F) -> Result<Option<&Self::Item>, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Returns the first element of the iterator which satisfies a predicate.

fn for_each<F>(self, f: F) -> Result<(), Self::Error> where
    F: FnMut(&Self::Item), 

Calls a closure on each element of an iterator.

fn fuse(self) -> Fuse<Self>

Returns an iterator which is well-behaved at the beginning and end of iteration.

fn map<F, B>(self, f: F) -> Map<Self, F, B> where
    F: FnMut(&Self::Item) -> B, 

Returns an iterator which applies a transform to elements.

fn map_ref<F, B>(self, f: F) -> MapRef<Self, F> where
    F: Fn(&Self::Item) -> &B,
    B: ?Sized, 

Returns an iterator which applies a transform to elements.

fn map_err<F, B>(self, f: F) -> MapErr<Self, F> where
    F: Fn(Self::Error) -> B, 

Returns an iterator that applies a transform to errors.

fn nth(&mut self, n: usize) -> Result<Option<&Self::Item>, Self::Error>

Returns the nth element of the iterator.

fn position<F>(&mut self, f: F) -> Result<Option<usize>, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Returns the position of the first element matching a predicate.

fn skip(self, n: usize) -> Skip<Self>

Returns an iterator which skips the first n elements.

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Returns an iterator which skips the first sequence of elements matching a predicate.

fn take(self, n: usize) -> Take<Self>

Returns an iterator which only returns the first n elements.

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Returns an iterator which only returns the first sequence of elements matching a predicate.

impl<'a, R: Read + Seek> FallibleStreamingIterator for FgbReader<'a, R, FeaturesSelectedSeek>

FallibleStreamingIterator differs from the standard library’s Iterator in two ways:

• each call to next can fail.
• returned FgbFeature is valid until next is called again or FgbReader is reset or finalized.

While these iterators cannot be used with Rust for loops, while let loops offer a similar level of ergonomics:

use flatgeobuf::*;

while let Some(feature) = fgb.next()? {
    let props = feature.properties()?;
    println!("{}", props["name"]);
}

type Error = GeozeroError

The error type of iteration.

type Item = FgbFeature

The type being iterated over.

fn advance(&mut self) -> Result<()>

Advances the iterator to the next position.

fn get(&self) -> Option<&FgbFeature>

Returns the current element.

fn size_hint(&self) -> (usize, Option<usize>)

Returns bounds on the number of remaining elements in the iterator.

fn next(&mut self) -> Result<Option<&Self::Item>, Self::Error>

Advances the iterator, returning the next element.

fn all<F>(&mut self, f: F) -> Result<bool, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Determines if all elements of the iterator satisfy a predicate.

fn any<F>(&mut self, f: F) -> Result<bool, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Determines if any elements of the iterator satisfy a predicate.

fn by_ref(&mut self) -> &mut Self

Borrows an iterator, rather than consuming it.

fn count(self) -> Result<usize, Self::Error>

Returns the number of remaining elements in the iterator.

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Returns an iterator which filters elements by a predicate.

fn find<F>(&mut self, f: F) -> Result<Option<&Self::Item>, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Returns the first element of the iterator which satisfies a predicate.

fn for_each<F>(self, f: F) -> Result<(), Self::Error> where
    F: FnMut(&Self::Item), 

Calls a closure on each element of an iterator.

fn fuse(self) -> Fuse<Self>

Returns an iterator which is well-behaved at the beginning and end of iteration.

fn map<F, B>(self, f: F) -> Map<Self, F, B> where
    F: FnMut(&Self::Item) -> B, 

Returns an iterator which applies a transform to elements.

fn map_ref<F, B>(self, f: F) -> MapRef<Self, F> where
    F: Fn(&Self::Item) -> &B,
    B: ?Sized, 

Returns an iterator which applies a transform to elements.

fn map_err<F, B>(self, f: F) -> MapErr<Self, F> where
    F: Fn(Self::Error) -> B, 

Returns an iterator that applies a transform to errors.

fn nth(&mut self, n: usize) -> Result<Option<&Self::Item>, Self::Error>

Returns the nth element of the iterator.

fn position<F>(&mut self, f: F) -> Result<Option<usize>, Self::Error> where
    F: FnMut(&Self::Item) -> bool, 

Returns the position of the first element matching a predicate.

fn skip(self, n: usize) -> Skip<Self>

Returns an iterator which skips the first n elements.

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Returns an iterator which skips the first sequence of elements matching a predicate.

fn take(self, n: usize) -> Take<Self>

Returns an iterator which only returns the first n elements.

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Returns an iterator which only returns the first sequence of elements matching a predicate.

impl<'a, T: Read> GeozeroDatasource for FgbReader<'a, T, FeaturesSelected>

fn process<P: FeatureProcessor>(&mut self, processor: &mut P) -> Result<()>

Consume and process all selected features.

fn process_geom<P>(&mut self, processor: &mut P) -> Result<(), GeozeroError> where
    P: GeomProcessor, 

Consume and process geometries of all selected features.

impl<'a, T: Read + Seek> GeozeroDatasource for FgbReader<'a, T, FeaturesSelectedSeek>

fn process<P: FeatureProcessor>(&mut self, processor: &mut P) -> Result<()>

Consume and process all selected features.

fn process_geom<P>(&mut self, processor: &mut P) -> Result<(), GeozeroError> where
    P: GeomProcessor, 

Consume and process geometries of all selected features.