Struct StorageRoots 

pub struct StorageRoots { /* private fields */ }

Optional roots used to resolve logical input and output paths.

Relative paths are joined to their corresponding root. Absolute paths are always treated as explicit locations and bypass the roots. Relative paths containing .. are rejected so a logical dataset path cannot escape its configured root.

Implementations

impl StorageRoots

pub const fn new( input_root: Option<PathBuf>, output_root: Option<PathBuf>, ) -> Self

Creates a root mapping. Either root may be omitted.

pub fn input_root(&self) -> Option<&Path>

Returns the configured input root, if any.

pub fn output_root(&self) -> Option<&Path>

Returns the configured output root, if any.

pub fn resolve_input(&self, path: impl AsRef<Path>) -> Result<PathBuf, IoError>

Resolves a logical input path against the configured input root.

pub fn resolve_output(&self, path: impl AsRef<Path>) -> Result<PathBuf, IoError>

Resolves a logical output path against the configured output root.

pub fn ensure_output_parent( &self, path: impl AsRef<Path>, ) -> Result<(), IoError>

Creates the parent directory for an explicit output path when needed.

pub fn preflight_output( &self, required_free_bytes: u64, ) -> Result<StoragePreflight, IoError>

Checks the configured output root before opening an external data source.

Trait Implementations

impl Clone for StorageRoots

fn clone(&self) -> StorageRoots

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageRoots

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

Formats the value using the given formatter.

impl Default for StorageRoots

fn default() -> StorageRoots

Returns the “default value” for a type.

impl PartialEq for StorageRoots

fn eq(&self, other: &StorageRoots) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StorageRoots

impl StructuralPartialEq for StorageRoots