Struct DatasetOpenBuilder 

pub struct DatasetOpenBuilder { /* private fields */ }

Builder for opening an existing geospatial dataset with configurable options.

Uses the fluent / method-chaining pattern. Finalise with .open().

Example

use oxigdal::builder::DatasetOpenBuilder;

let ds = DatasetOpenBuilder::new("world.tif")
    .read_only(true)
    .with_overview_level(1)
    .with_tile_cache_mb(64)
    .with_crs_override("EPSG:4326")
    .open()?;

Implementations

impl DatasetOpenBuilder

pub fn new(path: impl AsRef<Path>) -> Self

Create a new builder targeting the given path.

pub fn read_only(self, val: bool) -> Self

Set whether the dataset should be opened read-only (default: true).

When false the dataset is opened for read-write access. Not all drivers support write access, and those that do not will return an error from .open().

pub fn with_overview_level(self, level: u32) -> Self

Request a specific overview / pyramid level (0 = native resolution).

Higher values access lower-resolution overviews, which is significantly faster for display and thumbnail generation.

pub fn with_tile_cache_mb(self, mb: u32) -> Self

Set the tile/block cache size in megabytes.

A larger cache reduces disk I/O when reading many tiles.

pub fn with_crs_override(self, wkt: impl Into<String>) -> Self

Override the CRS reported by the file.

wkt can be an EPSG code string ("EPSG:4326"), a WKT2 string, or a PROJ definition string. This is useful when the file is missing CRS metadata.

pub fn with_format_hint(self, format: DatasetFormat) -> Self

Provide a format hint to skip magic-byte detection.

Only needed for files with non-standard or missing extensions.

pub fn path(&self) -> &Path

The configured path.

pub fn is_read_only(&self) -> bool

Whether read-only mode is enabled.

pub fn overview_level(&self) -> Option<u32>

Configured overview level, if any.

pub fn tile_cache_mb(&self) -> Option<u32>

Configured tile cache size in MB, if any.

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

Configured CRS override string, if any.

pub fn open(self) -> Result<OpenedDataset>

Open the dataset with the configured options.

Internally calls open() for format detection, then applies the configured options to the returned handle.

Errors

Propagates any error from open(). Additionally returns OxiGdalError::NotSupported if read_only = false is requested for a format that is currently read-only.

Trait Implementations

impl Clone for DatasetOpenBuilder

fn clone(&self) -> DatasetOpenBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatasetOpenBuilder

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

Formats the value using the given formatter.