Struct Dataset 

pub struct Dataset { /* private fields */ }

Unified dataset handle — the central abstraction (analogous to GDALDataset).

Opens any supported geospatial format and provides uniform access to raster bands, vector layers, and metadata.

Example

use oxigdal::Dataset;

let ds = Dataset::open("elevation.tif").expect("failed to open");
println!("{}×{} pixels, {} bands", ds.width(), ds.height(), ds.band_count());
println!("Format: {}", ds.format());
if let Some(crs) = ds.crs() {
    println!("CRS: {crs}");
}

Implementations

impl Dataset

pub fn open(path: &str) -> Result<Self>

Open a geospatial dataset from a file path — the universal entry point.

Format is auto-detected from file extension (and in the future, magic bytes), just like GDALOpen() in C GDAL.

Supported Formats

Which formats are available depends on enabled feature flags. With default features: GeoTIFF, GeoJSON, Shapefile.

Errors

Returns OxiGdalError::NotSupported if the format is not recognized or the corresponding feature flag is not enabled.

Returns OxiGdalError::Io if the file cannot be read.

pub fn open_with_format(path: &str, format: DatasetFormat) -> Result<Self>

Open a dataset with an explicitly specified format.

Use this when auto-detection from extension is insufficient (e.g., .json files that could be GeoJSON or STAC).

Errors

Returns error if the format’s feature flag is not enabled or file is unreadable.

pub fn path(&self) -> &str

File path this dataset was opened from.

pub fn format(&self) -> DatasetFormat

Detected dataset format.

pub fn info(&self) -> &DatasetInfo

Full dataset info.

pub fn width(&self) -> u32

Width in pixels (raster datasets). Returns 0 for vector-only datasets.

pub fn height(&self) -> u32

Height in pixels (raster datasets). Returns 0 for vector-only datasets.

pub fn crs(&self) -> Option<&str>

Coordinate reference system (WKT, EPSG code, or PROJ string).

pub fn band_count(&self) -> u32

Number of raster bands.

pub fn layer_count(&self) -> u32

Number of vector layers.

pub fn geotransform(&self) -> Option<&GeoTransform>

Geotransform coefficients.

[origin_x, pixel_width, rotation_x, origin_y, rotation_y, pixel_height]

Trait Implementations

impl Debug for Dataset

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

Formats the value using the given formatter.