Struct FsDirectory 

pub struct FsDirectory { /* private fields */ }

Local filesystem directory with async IO via tokio

Implementations

impl FsDirectory

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

Trait Implementations

impl Clone for FsDirectory

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FsDirectory

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

Formats the value using the given formatter.

impl Directory for FsDirectory

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if a file exists

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get file size

fn open_read<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<FileHandle>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open a file for reading (loads entire file into an inline FileHandle)

fn read_range<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, range: Range<u64>, ) -> Pin<Box<dyn Future<Output = Result<OwnedBytes>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read a specific byte range from a file (optimized for network)

fn list_files<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Vec<PathBuf>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List files in directory

fn open_lazy<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<FileHandle>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open a file handle that fetches ranges on demand. For mmap directories this returns an Inline handle (sync-capable). For HTTP/filesystem directories this returns a Lazy handle.

fn set_index_label(&self, label: &str)

Attach the owning index’s name for Directory-layer metric labels (summa_directory_read_*, summa_cold_write_bytes_total). Called by Index::open/create once the schema is loaded; wrappers forward to their inner directory. Default: no-op (directories that emit no Directory-layer metrics, e.g. RamDirectory).

fn local_path(&self, path: &Path) -> Option<PathBuf>

Resolve a directory-relative file to a native filesystem path.

impl DirectoryWriter for FsDirectory

fn write<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create/overwrite a file with data

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

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a file

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Atomic rename

fn link<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from: &'life1 Path, to: &'life2 Path, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create another immutable name for an existing file without copying its contents when the backend supports it. Segment rewrites use this to retain unchanged multi-gigabyte files while replacing only one index payload. Backends without link semantics return Unsupported; callers then fall back to a streaming copy.

fn sync<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sync all pending writes

fn streaming_writer<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn StreamingWriter>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a streaming writer for incremental file writes. Call finish() on the returned writer to finalize.

fn streaming_writer_cold<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn StreamingWriter>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Streaming writer for bulk one-shot data (merge/reorder outputs).

fn streaming_writer_cold_with_capacity<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 Path, buffer_capacity: usize, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn StreamingWriter>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Cold writer with a userspace buffering hint for concurrent outputs. Local files clamp the buffer to 1 byte through 8 MiB. Other backends may delegate to their usual cold writer; this does not bound owned output in memory-backed directories or backend-specific caches.

fn write_durable<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: &'life1 Path, data: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create/overwrite a file with data, durably.