Skip to main content

RealDiskFileStore

Struct RealDiskFileStore 

Source
pub struct RealDiskFileStore { /* private fields */ }
Expand description

A SessionFileSystem rooted at a real host directory.

Paths are interpreted per the session filesystem namespace rules (leading /, optional /workspace prefix, .. rejected anywhere). session_id is accepted on every method but ignored — the store is single-workspace per process. See knowledge/runtime-resources/file-store.md for the multi-tenant upgrade path.

is_readonly flags from seed_initial_file are tracked in an in-memory set (the disk backend has no place to persist them), so writes and deletes through this store still honor the trait contract within a single process. The flag is not mapped onto filesystem permissions — other host processes can still modify the file directly.

Implementations§

Source§

impl RealDiskFileStore

Source

pub fn new(root: impl Into<PathBuf>) -> Result<Self>

Create a new real-disk store rooted at root.

The root is canonicalized once at construction time. Any operation whose canonical-form path would escape the root is rejected.

Source

pub fn root(&self) -> PathBuf

The current canonicalized workspace root.

Source

pub fn set_host_root(&self, root: impl Into<PathBuf>) -> Result<()>

Repoint the workspace root, e.g. when an embedder switches worktrees.

The root handle is shared, so every clone of this store immediately addresses the new root. See EVE-660.

Trait Implementations§

Source§

impl Clone for RealDiskFileStore

Source§

fn clone(&self) -> RealDiskFileStore

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RealDiskFileStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl SessionFileSystem for RealDiskFileStore

Source§

fn display_root(&self) -> String

A real-disk store shows where files actually live: the host-absolute root. Filesystem decorators preserve this identity.

Source§

fn display_path(&self, path: &str) -> String

Convert a canonical session path into a human-facing path. Read more
Source§

fn resolve_path(&self, input: &str) -> String

Resolve an input path (any accepted spelling, relative or absolute) to an absolute path within this filesystem’s namespace. Relative inputs resolve against the filesystem’s current directory. Read more
Source§

fn is_mount_resolver(&self) -> bool

Whether this store is already a mount-based resolver (MountFs). Read more
Source§

fn seed_initial_file<'life0, 'life1, 'async_trait>( &'life0 self, session_id: SessionId, file: &'life1 InitialFile, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Seed a starter file into a session workspace.
Source§

fn read_file<'life0, 'life1, 'async_trait>( &'life0 self, session_id: SessionId, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<SessionFile>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read a file by path
Source§

fn write_file<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, session_id: SessionId, path: &'life1 str, content: &'life2 str, encoding: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<SessionFile>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Write/create a file
Source§

fn write_file_if_content_matches<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>( &'life0 self, session_id: SessionId, path: &'life1 str, expected_content: &'life2 str, expected_encoding: &'life3 str, content: &'life4 str, encoding: &'life5 str, ) -> Pin<Box<dyn Future<Output = Result<Option<SessionFile>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait,

Write a file only if its current content snapshot still matches. Read more
Source§

fn delete_file<'life0, 'life1, 'async_trait>( &'life0 self, _session_id: SessionId, path: &'life1 str, recursive: bool, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a file or directory
Source§

fn list_directory<'life0, 'life1, 'async_trait>( &'life0 self, session_id: SessionId, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<FileInfo>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List files in a directory
Source§

fn stat_file<'life0, 'life1, 'async_trait>( &'life0 self, _session_id: SessionId, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<FileStat>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get file metadata
Source§

fn grep_files<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _session_id: SessionId, pattern: &'life1 str, path_pattern: Option<&'life2 str>, ) -> Pin<Box<dyn Future<Output = Result<Vec<GrepMatch>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Search file contents with Rust regex syntax, optionally filtering canonical paths by glob. Read more
Source§

fn grep_files_with_options<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _session_id: SessionId, pattern: &'life1 str, options: &'life2 GrepOptions, ) -> Pin<Box<dyn Future<Output = Result<GrepSearchResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Search with match pagination and bounded before/after context. Read more
Source§

fn create_directory<'life0, 'life1, 'async_trait>( &'life0 self, session_id: SessionId, path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<FileInfo>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a directory

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more