Struct LocalFileProvider

pub struct LocalFileProvider;

Stateless synchronous provider for file: URIs on the host filesystem.

Paths are neither confined nor normalized before access. Methods inherit OS permissions, follow symlinks except where explicitly documented, and may block the calling thread; use LocalFileTreeSourceFactory with the runtime worker for retained file-tree operations.

Examples

use ailloli_ui_fs::FileProvider;
use ailloli_ui_fs_local::LocalFileProvider;
let provider = LocalFileProvider::new();
assert!(provider.capabilities().read);
assert!(provider.capabilities().watch);

Implementations

impl LocalFileProvider

Constructs the stateless local provider.

pub fn new() -> Self

Returns a zero-sized provider with no filesystem access performed yet.

Examples

use ailloli_ui_fs_local::LocalFileProvider;
let provider = LocalFileProvider::new();
assert_eq!(std::mem::size_of_val(&provider), 0);

Trait Implementations

impl Clone for LocalFileProvider

fn clone(&self) -> LocalFileProvider

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalFileProvider

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

Formats the value using the given formatter.

impl Default for LocalFileProvider

fn default() -> LocalFileProvider

Returns the “default value” for a type.

impl FileProvider for LocalFileProvider

Maps the generic provider contract to synchronous std::fs operations.

fn capabilities(&self) -> FileCapabilities

Advertises read/write plus native watch support.

fn read_dir(&self, uri: &FileUri) -> Result<Vec<FileEntry>, FileError>

Reads one directory level and sorts by name then URI path.

An empty directory returns an empty vector. Per-entry metadata failures abort the complete read rather than returning a partial list.

Errors

Returns [FileError::InvalidUri] for a non-local URI or an entry path that cannot become a local URI, and maps directory iteration or metadata failures through [FileError::from_io].

fn read_file(&self, uri: &FileUri) -> Result<Vec<u8>, FileError>

Reads the complete file into an owned byte vector.

Errors

Returns [FileError::InvalidUri] for a non-local URI and maps the host read failure through [FileError::from_io].

fn write_file(&self, uri: &FileUri, bytes: &[u8]) -> Result<(), FileError>

Creates or truncates a file and writes bytes non-atomically.

Empty bytes create an empty file. Missing parents are not created.

Errors

Returns [FileError::InvalidUri] for a non-local URI and maps create, truncate, or write failures through [FileError::from_io].

fn metadata(&self, uri: &FileUri) -> Result<FileMetadata, FileError>

Returns symlink-aware metadata without following the link for kind.

Errors

Returns [FileError::InvalidUri] for a non-local URI or a mapped host metadata error when the entry itself cannot be inspected.

fn canonical_uri(&self, uri: &FileUri) -> Result<Option<FileUri>, FileError>

Resolves the OS canonical path, returning None for any failure.

This deliberately collapses missing paths, permission failures, and other canonicalization errors to absence after URI validation succeeds.

Errors

Returns [FileError::InvalidUri] when the source is not local or a successful canonical host path cannot be represented as a local URI.

fn create_dir(&self, uri: &FileUri) -> Result<(), FileError>

Creates exactly one directory; parents are not created recursively.

Errors

Returns [FileError::InvalidUri] for a non-local URI and maps the host creation failure through [FileError::from_io].

fn rename(&self, from: &FileUri, to: &FileUri) -> Result<(), FileError>

Delegates an OS rename/move without cross-filesystem fallback.

Errors

Returns [FileError::InvalidUri] when either URI is non-local and maps every host rename failure, including cross-device moves, through [FileError::from_io].

fn remove(&self, uri: &FileUri) -> Result<(), FileError>

Removes one file, symlink, or empty directory non-recursively.

symlink_metadata ensures a link to a directory removes the link with remove_file, never the target directory.

Errors

Returns [FileError::InvalidUri] for a non-local URI and maps metadata, file removal, or empty-directory removal failures through [FileError::from_io].

fn copy_entry(&self, from: &FileUri, to: &FileUri) -> Result<(), FileError>

Recursively copies an entry using the provider’s primitive methods.

fn move_entry(&self, from: &FileUri, to: &FileUri) -> Result<(), FileError>

Moves an entry; the default delegates directly to [Self::rename].

fn remove_recursive(&self, uri: &FileUri) -> Result<(), FileError>

Removes an entry subtree depth-first using primitive provider methods.