Struct FsClient 

pub struct FsClient<F> { /* private fields */ }

Cloneable owner of one synchronous backend connection.

Implementations

impl<F> FsClient<F>

pub fn new(filesystem: F) -> Self

pub fn into_inner(self) -> Result<F, Self>

impl<F: FileSystem> FsClient<F>

pub fn open(&self, path: impl AsRef<Path>) -> VfResult<FsFile<F>>

Open a path read-only.

pub fn open_with(&self, request: OpenRequest) -> VfResult<FsFile<F>>

pub fn open_options(&self) -> OpenOptions<'_, F>

pub fn create(&self, path: impl AsRef<Path>) -> VfResult<FsFile<F>>

pub fn read(&self, path: impl AsRef<Path>) -> VfResult<Vec<u8>>

pub fn read_with_limit( &self, path: impl AsRef<Path>, max_bytes: usize, ) -> VfResult<Vec<u8>>

Read one complete file while limiting the returned allocation.

Use FsFile::read_native or std::io::Read to stream files that should not be held in one allocation.

pub fn read_to_string(&self, path: impl AsRef<Path>) -> VfResult<String>

pub fn read_to_string_with_limit( &self, path: impl AsRef<Path>, max_bytes: usize, ) -> VfResult<String>

Read one complete UTF-8 file with a caller-selected allocation limit.

pub fn write(&self, path: impl AsRef<Path>, data: &[u8]) -> VfResult<()>

impl<F: MetadataFileSystem> FsClient<F>

pub fn metadata(&self, path: impl AsRef<Path>) -> VfResult<Metadata>

pub fn symlink_metadata(&self, path: impl AsRef<Path>) -> VfResult<Metadata>

pub fn set_metadata(&self, path: impl AsRef<Path>) -> SetMetadata<'_, F>

impl<F: DirectoryFileSystem> FsClient<F>

pub fn create_dir(&self, path: impl AsRef<Path>) -> VfResult<()>

pub fn create_dir_with_mode( &self, path: impl AsRef<Path>, mode: u32, ) -> VfResult<()>

pub fn read_dir(&self, path: impl AsRef<Path>) -> VfResult<Vec<DirEntry>>

pub fn read_dir_with_options( &self, path: impl AsRef<Path>, options: ReadDirOptions, ) -> VfResult<Vec<DirEntry>>

Read one directory with explicit entry and path-storage limits.

impl<F: DirectoryFileSystem + MetadataFileSystem> FsClient<F>

pub fn create_dir_all(&self, path: impl AsRef<Path>) -> VfResult<()>

impl<F: NamespaceFileSystem + MetadataFileSystem> FsClient<F>

pub fn remove_file(&self, path: impl AsRef<Path>) -> VfResult<()>

pub fn remove_dir(&self, path: impl AsRef<Path>) -> VfResult<()>

pub fn remove_dir_all(&self, path: impl AsRef<Path>) -> VfResult<()>

pub fn rename( &self, from: impl AsRef<Path>, to: impl AsRef<Path>, ) -> VfResult<()>

impl<F: LinkFileSystem> FsClient<F>

pub fn symlink( &self, target: impl AsRef<Path>, link: impl AsRef<Path>, ) -> VfResult<()>

pub fn hard_link( &self, source: impl AsRef<Path>, link: impl AsRef<Path>, ) -> VfResult<()>

pub fn read_link(&self, path: impl AsRef<Path>) -> VfResult<PathBuf>

impl<F: CopyFileSystem> FsClient<F>

pub fn copy( &self, source: impl AsRef<Path>, destination: impl AsRef<Path>, ) -> VfResult<()>

impl<F: VectorFileSystem> FsClient<F>

pub fn openv(&self, requests: &[OpenRequest]) -> VfResult<Vec<FsFile<F>>>

Open an ordered vector of files.

Success returns one RAII handle per request. Failure returns no handles; VFSI does not promise transactional rollback of other filesystem effects such as file creation.

pub fn closev(&self, files: Vec<FsFile<F>>) -> VfResult<()>

Close a group of files through one vector operation.

On failure, each handle remains armed for best-effort cleanup on drop; explicitly closed prefix handles may consequently receive a harmless second close attempt.

pub fn readv(&self, requests: &[FsRead<'_, F>]) -> VfResult<Vec<ReadResult>>

pub fn readv_into( &self, requests: &mut [FsReadInto<'_, F>], ) -> VfResult<Vec<usize>>

pub fn writev(&self, requests: &[FsWrite<'_, F>]) -> VfResult<Vec<WriteResult>>

Trait Implementations

impl<F> Clone for FsClient<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Debug for FsClient<F>

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

Formats the value using the given formatter.