# Changes
## Unreleased
## 0.16
- **Breaking**: `Dataset::close` now consumes `self`
- <https://github.com/georust/gdal/pull/420>
- `Gcp` and `GcpRef` are now public
- <https://github.com/georust/gdal/pull/421>
- Fixed build error with GDAL 3.1
- <https://github.com/georust/gdal/pull/416>
## 0.15
- **Breaking**: `RasterBand::actual_block_size` now takes two `usize` offsets instead of `(isize, isize)`
- <https://github.com/georust/gdal/pull/413>
- Added `GDT_Int8` support
- <https://github.com/georust/gdal/pull/412>
- Added `Dataset::close`, changed `Dataset::flush_cache` to be fallible
- <https://github.com/georust/gdal/pull/410>
- Added `SpatialRef::semi_major`, `semi_minor`, `set_proj_param`, `get_proj_param`, `get_proj_param_or_default`, `set_attr_value`, `get_attr_value` and `geog_cs`.
- <https://github.com/georust/gdal/pull/406>
- Added `Dataset::gcp_projection`, `Dataset::gcps`, `Dataset::set_gcps` APIs
- <https://github.com/georust/gdal/pull/404>
- Added pre-built bindings for GDAL 3.7
- <https://github.com/georust/gdal/pull/410>
- Added `SpatialRef::to_projjson`
- <https://github.com/georust/gdal/pull/389>
- Added `Geometry::length`
- <https://github.com/georust/gdal/pull/384>
- Added `Geometry::union`
- <https://github.com/georust/gdal/pull/379>
- Added `Geometry::from_gml`
- <https://github.com/georust/gdal/pull/378>
- Added `CoordTransform::new_with_options` and `CoordTransformOptions`
- <https://github.com/georust/gdal/pull/372>
- Set the link flag of gdal-sys to "libgdal". Emit the libgdal version via cargo:version_number. Remove wrong build-dependency on gdal-sys and remove docs_rs workaround.
- <https://github.com/georust/gdal/pull/377>
- Added `Geometry::from_geojson`
- <https://github.com/georust/gdal/pull/375>
- Added `CslStringList::add_string`
- <https://github.com/georust/gdal/pull/364>
- **Possibly breaking**: Set MSRV to 1.58.
- <https://github.com/georust/gdal/pull/363>
- Added a `TryFrom` array implementation for `CslStringList`
- <https://github.com/georust/gdal/pull/362>
- Added `Rasterband::c_rasterband` to obtain the raw C pointer to `GDALRasterBandH`
- <https://github.com/georust/gdal/pull/359>
- **Breaking**: `Feature::geometry` returns an `Option<&Geometry>` instead of `&Geometry`. Calls to `Feature::geometry` will no longer panic.
- <https://github.com/georust/gdal/pull/349>
- **Breaking**: `RasterBand::band_type` returns the `GdalDataType` enum instead of `GDALDataType::Type` ordinal. Fixes [#333](https://github.com/georust/gdal/issues/333)
- <https://github.com/georust/gdal/pull/334>
- The default features of the `chrono` dependency are now disabled
- <https://github.com/georust/gdal/pull/347>
- Added prebuilt bindings for GDAL 3.6 (released 6 November 2022).
- <https://github.com/georust/gdal/pull/352>
- **Breaking**: `Layer::spatial_ref` returns `Option` instead of `Result`, thereby better reflecting the semantics documented in the [C++ API](https://gdal.org/doxygen/classOGRLayer.html#a75c06b4993f8eb76b569f37365cd19ab)
- <https://github.com/georust/gdal/pull/355>
- Exposed various functions on `Geometry`: `make_valid`, `geometry_name`, and `point_count`.
- <https://github.com/georust/gdal/pull/356>
- Exposed `read_arrow_stream` on `Layer` to access OGR's columnar reading API.
- <https://github.com/georust/gdal/pull/367>
- Exposed spatial predicates over `Geometry`: `intersects`, `contains`, `disjoint`, `touches`, `crosses`, `within`, and `overlaps`.
- <https://github.com/georust/gdal/pull/366>
- Added `Geometry::envelope` and `Geometry::envelope_3d`.
- <https://github.com/georust/gdal/pull/370>
- Added support for getting the `SpatialRef` of embedded ground control points (GCPs) via `Dataset::gcp_spatial_ref`.
- <https://github.com/georust/gdal/pull/397>
## 0.14
- Added new content to `README.md` and the root docs.
- <https://github.com/georust/gdal/pull/296>
- Fixed a crash in `Group::dimensions` and `MDArray::dimensions` when no dimensions exist
- <https://github.com/georust/gdal/pull/303>
- Added a more ergonomic means of accessing GDAL version properties
- <https://github.com/georust/gdal/pull/305>
- Provided access to `gdal-sys` discriminant values in `ResampleAlg` enum.
- <https://github.com/georust/gdal/pull/309>
- **Breaking** `RasterBand::set_no_data_value` takes `Option<f64>` instead of `f64` so that no _no-data_ can be set.
Also makes it symmetric with `RasterBand::no_data_value` which returns `Option<f64>`.
- <https://github.com/georust/gdal/pull/308>
- Added quality-of-life features to `CslStringList`: `len`, `is_empty`, `Debug` and `Iterator` implementations.
- <https://github.com/georust/gdal/pull/311>
- Added ability to set color table for bands with palette color interpretation.
Added ability to create a color ramp (interpolated) color table.
- <https://github.com/georust/gdal/pull/314>
- Added a wrapper for the `DriverManager`
- <https://github.com/georust/gdal/pull/324>
- Added `GdalDataType` to provide access to metadata and supporting routines around `GDALDataType` ordinals.
- **Breaking**: `GDALDataType` is no longer `pub use` in `gdal::raster`,
as `GdalType` and `GdalDataType` sufficiently cover use cases in safe code.
Still accessible via `gdal_sys::GDALDataType`.
- <https://github.com/georust/gdal/pull/318>
- Added `Metadata` iterator.
- <https://github.com/georust/gdal/pull/344>
## 0.13
- Add prebuilt bindings for GDAL 3.5
- <https://github.com/georust/gdal/pull/277>
- **Breaking**: Add `gdal::vector::OwnedLayer`, `gdal::vector::LayerAccess` and `gdal::vector::layer::OwnedFeatureIterator`. This requires importing `gdal::vector::LayerAccess` for using most vector layer methods.
- https://github.com/georust/gdal/pull/238
- **Breaking**: `SpatialRef::from_c_obj` is now unsafe.
- https://github.com/georust/gdal/pull/267
- **Breaking**: Rename `Driver::get` to `Driver::get_by_name`, add `Driver::get(usize)` and `Driver::count`
- <https://github.com/georust/gdal/pull/251>
- Implemented wrapper for `OGR_L_SetFeature`
- <https://github.com/georust/gdal/pull/264>
- Add `programs::raster::build_vrt`
- Add `GeoTransformEx` extension trait with `apply` and `invert`
- <https://github.com/georust/gdal/pull/239>
- Add `gdal::vector::geometry_type_to_name` and `gdal::vector::field_type_to_name`
- <https://github.com/georust/gdal/pull/250>
- <https://github.com/georust/gdal/pull/258>
- Add `gdal::raster::rasterband::RasterBand::unit` as wrapper for `GDALGetRasterUnitType`
- <https://github.com/georust/gdal/pull/271>
- Add `gdal::vsi::read_dir` function.
- <https://github.com/georust/gdal/pull/257>
- Add a `ColorTable` struct and `RasterBand::color_table` method
- <https://github.com/georust/gdal/pull/246>
- Add `GeometryRef<'a>` to reference owned nested geometry in a lifetime-safe way.
- <https://github.com/georust/gdal/pull/274>
- Add support for MDArray API
- <https://github.com/georust/gdal/pull/273>
- Add `gdal::srs::CoordTransform::transform_bounds` as wrapper for `OCTTransformBounds` for GDAL 3.4
- <https://github.com/georust/gdal/pull/272>
- Add `Feature::set_field_*_list` functions for list field types
- <https://github.com/georust/gdal/pull/278>
- Deprecate `Transaction::dataset` and `Transaction::dataset_mut`. Add `Deref` and `DerefMut` implementations instead.
- <https://github.com/georust/gdal/pull/265>
- Add methods to access raster masks and get raster mask flags. (`open_mask_band`, `create_mask_band`, and `mask_flags`).
- <https://github.com/georust/gdal/pull/285>
- Remove `PartialEq` from `GdalError`
- <https://github.com/georust/gdal/pull/286>
- Prevent SIGGEGV when reading a string array on an MD Array that is not of type string.
- <https://github.com/georust/gdal/pull/284>
- Added `Geometry::to_geo` method for GDAL to geo-types Geometry conversions.
- <https://github.com/georust/gdal/pull/295>
- Add `Rasterband::set_scale` and `Rasterband::set_offset` methods
- <https://github.com/georust/gdal/pull/294>
- Added program wrapper for `GDALMultiDimTranslate`
- <https://github.com/georust/gdal/pull/289>
- Test that `GdalError` is `Send`
- <https://github.com/georust/gdal/pull/293>
- Allow reading `Dimension`s from `Group`s in multimensional `Dataset`s.
- <https://github.com/georust/gdal/pull/291>
- Added wrapper methods for `GDALGetRasterStatistics`, `GDALComputeRasterMinMax` and `GDALMDArrayGetStatistics`.
- <https://github.com/georust/gdal/pull/292>
- Added a workaround in multi-dim tests to not access files multiple times
- <https://github.com/georust/gdal/pull/302>
## 0.12
- Bump Rust edition to 2021
- Add prebuild bindings for GDAL 3.4
- <https://github.com/georust/gdal/pull/231>
## 0.11
- Remove the `datetime` feature
- <https://github.com/georust/gdal/pull/229>
- Add `cpl::CslStringList`
- <https://github.com/georust/gdal/pull/223>
- Make `gdal::rasters::OptimizeMode` public
- <https://github.com/georust/gdal/pull/224>
- Added `rename` and `delete` to `gdal::Driver`
- <https://github.com/georust/gdal/pull/226>
- **Breaking**: File paths must now implement `AsRef<Path>`
- <https://github.com/georust/gdal/pull/230>
## 0.8 - 0.10
- Update types to fix build on ppc64le.
- <https://github.com/georust/gdal/pull/214/>
- Upgrade `semver` to 1.0 and trim gdal version output in `build.rs`.
- <https://github.com/georust/gdal/pull/211/>
- **Breaking**: Make `set_attribute_filter` and `clear_attribute_filter` take `&mut self`
- <https://github.com/georust/gdal/pull/209/>
- **Breaking**: Drop pre-build bindings for GDAL versions < 2.4. The bindgen feature can be used to generate bindings for older versions.
- Fix memory leaks reported by Valgrind. This required re-generation of the pre-build bindings.
- <https://github.com/georust/gdal/pull/205>
- **Breaking**: Implement `TryFrom` instead of `From` to convert from gdal geometries to `geo-types`. This avoids a possible panic on unsupported geometries and returns an error instead.
- Add `Feature::c_feature` that returns the OGR feature handle.
- <https://github.com/georust/gdal/pull/192>
- Add wrapper for `OGR_G_Buffer`.
- Add support for raster dataset creation options. A new struct (`RasterCreationOption`) and function (`driver.create_with_band_type_with_options()`) are now available for this.
- <https://github.com/georust/gdal/pull/193>
```rust
let driver = Driver::get_by_name("GTiff").unwrap();
let options = &[
RasterCreationOption {
key: "COMPRESS",
value: "LZW",
},
RasterCreationOption {
key: "TILED",
value: "YES",
},
];
let mut dataset = driver
.create_with_band_type_with_options::<u8>("testing.tif", 2048, 2048, 1, options)
.unwrap();
```
- **Breaking**: Add support to select a resampling algorithm when reading a raster
- <https://github.com/georust/gdal/pull/141>
Now, it is necessary to provide a `Option<ResampleAlg>` when reading a raster.
If `None`, it uses `ResampleAlg::NearestNeighbour` which was the
default behavior.
- **Breaking**: Make `Layer::features` iterator reset to
beginning, and borrow mutably.
- closes <https://github.com/georust/gdal/issues/159>
- **Breaking**: [Enforce borrow
semantics](https://github.com/georust/gdal/pull/161) on
methods of `Dataset`, `RasterBand`, and `Layer`.
1. Methods that do not modify the underlying structure take `&self`.
1. Methods that modify the underlying structure take `&mut self`.
```rust
let ds = Dataset::open(...);
let mut band = ds.rasterband(1)?;
band.set_no_data_value(0.0)?;
```
- **Breaking**: Upgrade to `ndarray 0.15`
- <https://github.com/georust/gdal/pull/175>
- Implement wrapper for `OGR_L_TestCapability`
- <https://github.com/georust/gdal/pull/160>
- **Breaking**: Use `DatasetOptions` to pass as `Dataset::open_ex` parameters and
add support for extended open flags.
```rust
use gdal::{ Dataset, DatasetOptions }
let dataset = Dataset::open_ex(
"roads.geojson",
DatasetOptions {
open_flags: GdalOpenFlags::GDAL_OF_UPDATE|GdalOpenFlags::GDAL_OF_VECTOR,
..DatasetOptions::default()
}
)
.unwrap();
```
`GDALAccess` values are supported using [`From`] implementation
```rust
Dataset::open_ex(
"roads.geojson",
DatasetOptions {
open_flags: GDALAccess::GA_Update.into(),
..DatasetOptions::default()
},
)
.unwrap();
```
- Add more functions to SpatialRef implementation
- <https://github.com/georust/gdal/pull/145>
- **Breaking**: Change `Feature::field` return type from
`Result<FieldValue>` to `Result<Option<FieldValue>>`. Fields
can be null. Before this change, if a field was null, the value
returned was the default value for the underlying type.
However, this made it impossible to distinguish between null
fields and legitimate values which happen to be default value,
for example, an Integer field that is absent (null) from a 0,
which can be a valid value. After this change, if a field is
null, `None` is returned, rather than the default value.
If you happened to rely on this behavior, you can fix your code
by explicitly choosing a default value when the field is null.
For example, if you had this before:
```rust
let str_var = feature.field("string_field")?
.into_string()
.unwrap();
```
You could maintain the old behavior with:
```rust
use gdal::vector::FieldValue;
let str_var = feature.field("string_field")?
.unwrap_or(FieldValue::StringValue("".into()))
.into_string()
.unwrap();
```
- <https://github.com/georust/gdal/pull/134>
- Fixed potential race condition wrt. GDAL driver initialization
- <https://github.com/georust/gdal/pull/166>
- Add basic support to read overviews
- Added a `Dataset::build_overviews` method
- <https://github.com/georust/gdal/pull/164>
- BREAKING: update geo-types to 0.7.0. geo-types Coordinate<T> now implement `Debug`
- <https://github.com/georust/gdal/pull/146>
- Deprecated `SpatialRef::get_axis_mapping_strategy` - migrate to
`SpatialRef::axis_mapping_strategy` instead.
- Add support for reading and setting rasterband colour interpretations
- <https://github.com/georust/gdal/pull/144>
- Add `Geometry::from_wkb` and `Geometry::wkb` functions to convert from/to
Well-Known Binary
- <https://github.com/georust/gdal/pull/173>
- Fixed memory leak in `Geometry::from_wkt`
- <https://github.com/georust/gdal/pull/172>
- **Breaking**: Changed `Dataset::create_layer` to take a new `LayerOptions`
struct instead of separate arguments.
Before:
```rust
ds.create_layer("roads", None, wkbLineString)
```
After (all fields have usable default values):
```rust
use gdal::LayerOptions;
ds.create_layer(LayerOptions {
name: "roads",
ty: wkbLineString,
..Default::default()
});
```
This change also removed `Dataset::create_layer_blank()`. Use
`Dataset::create_layer(Default::default())` instead.
- <https://github.com/georust/gdal/pull/186>
- Wrapper functions for `OGR_F_GetFieldAs…` methods
- <https://github.com/georust/gdal/pull/199>
- Wrapper functions for `OGR_L_SetAttributeFilter` and `OGR_L_SetSpatialFilterRect`
- <https://github.com/georust/gdal/pull/200>
- Wrappers for `CPLSetThreadLocalConfigOption` and `CPLGetThreadLocalConfigOption`
- <https://github.com/georust/gdal/pull/201>
- Wrappers for `VSIFileFromMemBuffer`, `VSIUnlink` and `VSIGetMemFileBuffer`
- <https://github.com/georust/gdal/pull/203>
- Add `set_description` to the `Metadata` trait
- <https://github.com/georust/gdal/pull/212>
- Wrappers for `GDALRasterizeGeometries` provided in a new `rasters::rasterize` function
- <https://github.com/georust/gdal/pull/213>
- Added `set_error_handler` and `remove_error_handler` to the config module that wraps `CPLSetErrorHandlerEx`
- <https://github.com/georust/gdal/pull/215>
- **Breaking**: Changed `Dataset::create_copy` to take a slice of `RasterCreationOption`s which was previously not included.
- <https://github.com/georust/gdal/pull/220>
Before:
```rust
dataset.create_copy(&driver, "output_file");
```
After:
```rust
dataset.create_copy(&driver, "output_file", &[]);
```
## 0.7.1
- fix docs.rs build for gdal-sys
- <https://github.com/georust/gdal/pull/128>
## 0.6.0 - 0.7.0
- Dataset layer iteration and FieldValue types
- https://github.com/georust/gdal/pull/126
- Fix i8 ptr instead of c_char ptr passed to OSRImportFromESRI()
- <https://github.com/georust/gdal/pull/123>
- Rename spatial_reference to spatial_ref
- <https://github.com/georust/gdal/pull/114>
- Replace get_extent force flag by get_extent and try_get_extent
- <https://github.com/georust/gdal/pull/113>
- Add support for transactions on datasets
- <https://github.com/georust/gdal/pull/109>
- Add feature_count{,\_force} and implement Iterator::size_hint
- <https://github.com/georust/gdal/pull/108>
- Replace failure with thiserror
- <https://github.com/georust/gdal/pull/103>
- Ability to read into preallocated slice for rasterband
- <https://github.com/georust/gdal/pull/100>
- Datasets are Send (requires GDAL >= 2.3)
- <https://github.com/georust/gdal/pull/99>
- User GDALOpenEx
- <https://github.com/georust/gdal/pull/97>
- GDAL 2.0 conform structure / drop GDAL 1.x
- <https://github.com/georust/gdal/pull/96>
- Inplace functions use mutable refs
- <https://github.com/georust/gdal/pull/93>
- Detect GDAL version at build time / remove version features
- <https://github.com/georust/gdal/pull/92>
- Add support for delaunay_triangulation and simplify functions
- <https://github.com/georust/gdal/pull/91>
- Add support for 3d points
- <https://github.com/georust/gdal/pull/90>
- Additional metadata retrieval options
- <https://github.com/georust/gdal/pull/88>
- Support for GDAL 3 in CI
- <https://github.com/georust/gdal/pull/86>
- Support for Integer64
- <https://github.com/georust/gdal/pull/80>
- Geometry Intersection trait
- <https://github.com/georust/gdal/pull/78>
- Rust 2018
- <https://github.com/georust/gdal/pull/75>
- support for date and time fields
- <https://github.com/georust/gdal/pull/72>
- Prebuild bindings
- <https://github.com/georust/gdal/pull/69>
- Support for ndarray
- <https://github.com/georust/gdal/pull/68>
## 0.5.0
- [Bump geo-types from 0.3 -> 0.4](https://github.com/georust/gdal/pull/71)
- [Allow reading block-size of Rasters](https://github.com/georust/gdal/pull/67)
- [Add prebuilt-bindings GDAL 2.3 and GDAL 2.4](https://github.com/georust/gdal/pull/69)
- [Make GdalType trait public](https://github.com/georust/gdal/pull/66)
- [RasterBand to Ndarray, with failure](https://github.com/georust/gdal/pull/68)
## 0.4.0
- [Migrate to the `geo-types` crate](https://github.com/georust/gdal/pull/60)
- [Replace `error-chain` with `failure`](https://github.com/georust/gdal/pull/58)
- [Use `bindgen` to generate the low-level bindings](https://github.com/georust/gdal/pull/55)
## 0.3.0
- [Add support for creating a SpatialRef from a esri "wkt" definition](https://github.com/georust/gdal/pull/37)
- [Travis now uses GDAL 2.x](https://github.com/georust/gdal/pull/36)
- [API extensions](https://github.com/georust/gdal/pull/35)
- [Extend the existing possibilities of writing ogr datasets](https://github.com/georust/gdal/pull/31)
- [Allow to transform ogr geometries to other SRS](https://github.com/georust/gdal/pull/29)
- [Move ffi into a seperate crate](https://github.com/georust/gdal/pull/26)
- [Added rasterband.rs and moved all band functions](https://github.com/georust/gdal/pull/24)
## 0.2.1
- [First version of metadata handling](https://github.com/georust/gdal/pull/21)