Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.51 KB

README.md

File metadata and controls

54 lines (36 loc) · 2.51 KB
Raw

gdal-sys

Build Status

Low level GDAL bindings for Rust. The build script will try to auto-detect the installed GDAL version.

Contains:

  • mapping of data types
  • raster (GDAL) and vector (OGR) operations
  • error handling
  • spatial reference operations

Build

The build script should work an Linux and Windows systems. It can be configured with a couple of environment variables:

  • if GDAL_INCLUDE_DIR or GDAL_LIB_DIR are defined, they will be used. You should also set GDAL_VERSION to X.Y.Z
  • otherwise, if GDAL_HOME is defined, the build script looks for GDAL_HOME/include, GDAL_HOME/lib and GDAL_HOME/bin
  • finally, pkg-config is queried to determine the GDAL location
  • you can define GDAL_STATIC to link GDAL statically

The include directories are only used if you choose to generate the bindings at build time.

On Linux, building should work out-of-the-box.

On Windows, the easiest solution is to point the GDAL_HOME environment variable to the GDAL folder.

  • windows-msvc requires gdal_i.lib to be found in %GDAL_HOME%\lib.
  • windows-gnu requires either gdal_i.lib in %GDAL_HOME%\lib OR gdal{version}.dll in %GDAL_HOME%\bin.

Generated bindings

By default, gdal-sys will detect the version of libgdal you have installed and attempt to use prebuilt bindings corresponding to that version. Alternatively, you can generate your own bindings from your libgdal installation by specifying the bindgen feature.

Creating prebuilt bindings

If a new version of GDAL is released, you (as a gdal contributor) can generate new bindings for inclusion in the gdal-sys source distribution by building with the bindgen feature, and then copying the generated file. For example (the hash will differ in your build):

$ cargo build --features bindgen
$ cp target/debug/build/gdal-sys-db833e3088b78e57/out/bindings.rs gdal-sys/prebuilt-bindings/gdal_3_6.rs

If your're not on a rolling distro, the following command might help:

$ podman run --rm -it -v $PWD:$PWD:z -w $PWD ghcr.io/osgeo/gdal:ubuntu-full-3.9.3 bash -c "curl --proto =https --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal --default-toolchain stable; . ~/.cargo/env && apt update && apt install -y pkg-config gcc libclang-dev && cargo clean && cargo test --features bindgen && shopt -s globstar && mv target/**/bindings.rs gdal-sys/prebuilt-bindings/gdal_3_9.rs"