Skip to main content

WalkerFs

kaish_kernel::walker

Trait WalkerFs 

Source 
pub trait WalkerFs: Send + Sync {
    type DirEntry: WalkerDirEntry;

    // Required methods
    fn list_dir<'life0, 'life1, 'async_trait>(
        &'life0 self,
        path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<Self::DirEntry>, WalkerError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait;
    fn read_file<'life0, 'life1, 'async_trait>(
        &'life0 self,
        path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, WalkerError>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait;
    fn is_dir<'life0, 'life1, 'async_trait>(
        &'life0 self,
        path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait;
    fn exists<'life0, 'life1, 'async_trait>(
        &'life0 self,
        path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait;

    // Provided methods
    fn canonicalize<'life0, 'life1, 'async_trait>(
        &'life0 self,
        path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = PathBuf> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait { ... }
    fn file_size<'life0, 'life1, 'async_trait>(
        &'life0 self,
        _path: &'life1 Path,
    ) -> Pin<Box<dyn Future<Output = Option<u64>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             'life1: 'async_trait,
             Self: 'async_trait { ... }
}
Expand description

Minimal read-only filesystem abstraction for the walker.

Implement this trait to adapt your project’s filesystem layer (VFS, real FS, CRDT blocks, etc.) to FileWalker and IgnoreFilter.

Required Associated Types§

Source

type DirEntry: WalkerDirEntry

The directory entry type returned by list_dir.

Required Methods§

Source

fn list_dir<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<Self::DirEntry>, WalkerError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

List the entries in a directory.

Source

fn read_file<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, WalkerError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Read the full contents of a file into memory.

Currently used for loading .gitignore files. Implementations SHOULD impose a reasonable size limit to prevent accidental multi-gigabyte reads.

Source

fn is_dir<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Check if a path is a directory.

Source

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Check if a path exists.

Provided Methods§

Source

fn canonicalize<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = PathBuf> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Return the canonical (resolved) path, following symlinks.

Used by FileWalker for symlink cycle detection when follow_symlinks is enabled. Implementations that support symlinks should resolve the path to its real location. The default returns the path unchanged.

Source

fn file_size<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Option<u64>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Return the file size in bytes, or None if size cannot be determined.

Used by FileWalker to honor WalkOptions::max_filesize. Implementations that don’t know file sizes (or for which a size query is too expensive) may return None — the walker treats that as “unknown size” and yields the file regardless of the limit.

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§

Source§

impl WalkerFs for BackendWalkerFs<'_>

Source§

type DirEntry = BackendDirEntry