spadarian / gdal

Rust bindings for GDAL

GDAL

GDAL is a translator and processing library for various raster and vector geospatial data formats.

This crate provides safe, idiomatic Rust bindings for GDAL.

Capabilities

GDAL is an incredibly powerful library. For a general understanding of its capabilities, a good place to get started is the GDAL User-oriented documentation. These features include:

• Opening raster and vector file formats for reading/writing
• Translating between file formats
• Reading and writing metadata in raster and vector datasets
• Accessing raster bands and their metadata
• Reading and writing geospatial coordinate system and projection values
• Warping (resampling and re-projecting) between coordinate systems

Documentation

This crate's API documentation is hosted on docs.rs.

The Rust documentation is currently a work in progress, and may not cover requisite details on parameter semantics, value interpretation, etc. Therefore, the authoritative documentation is that of GDAL in the form of its C and C++ APIs. The former is technically what this crate calls, but the latter is usually more clear and better documented.

Usage

This crate provides high-level, idiomatic Rust bindings for GDAL. To do that, it uses gdal-sys internally, a low-level interface to the GDAL C library, which is generated using bindgen. Using the gdal-sys crate directly is normally not needed, but it can be useful in order to call APIs that have not yet been exposed in gdal.

Building this crate assumes a compatible version of GDAL is installed with the corresponding header files and shared libraries. This repository includes pre-generated bindings for GDAL 2.4 through 3.6 (see thegdal-sys/prebuilt-bindings directory). If you're compiling against a later version of GDAL, you can enable the bindgen feature flag to have new bindings generated on the fly.

Community

This crate is part of the expansive (and expanding!) georust organization. Come join our discussions on Discord!

Contributing

This crate continues to evolve, and PRs are welcome. Make sure you are comfortable with the Code of Conduct and License before submitting a PR.

License

This library is released under the MIT license