Struct FsResolver

pub struct FsResolver { /* private fields */ }

Loads layers from the local filesystem. Requires the fs feature.

An import uri is a file path. A relative path resolves against the directory of the importing layer, and the main layer’s against the current directory. Keys are canonical paths where the file exists, so a layer reached by different relative paths loads once.

URIs with a scheme (scheme://...) are rejected with FsError::UnsupportedUri unless map_prefix maps them to a local directory, for example an offline mirror of ifcx.dev:

use openbim_ifcx::layers::{FsResolver, LayerStackBuilder};

let resolver = FsResolver::new().map_prefix("https://ifcx.dev/", "mirror/ifcx.dev");
let stack = LayerStackBuilder::new(resolver).build("model.ifcx")?;

Implementations

impl FsResolver

pub fn new() -> Self

pub fn map_prefix( self, prefix: impl Into<String>, dir: impl Into<PathBuf>, ) -> Self

Resolves URIs starting with prefix to the rest of the URI below dir. The first matching prefix in insertion order applies. The rest is used as written; percent-escapes are not decoded.

Trait Implementations

impl Clone for FsResolver

fn clone(&self) -> FsResolver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FsResolver

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

Formats the value using the given formatter.

impl Default for FsResolver

fn default() -> FsResolver

Returns the “default value” for a type.

impl LayerResolver for FsResolver

type Error = FsError

Failure other than a missing layer, such as an I/O error.

fn key(&mut self, uri: &str, importer: Option<&str>) -> Result<String, FsError>

Identifies the layer that uri names. importer is the key of the layer whose imports list uri, or None for the main layer, so relative references can resolve against it.

fn load(&mut self, key: &str) -> Result<Option<Vec<u8>>, FsError>

Returns the bytes of the layer with this key, or Ok(None) when there is no such layer.