Struct fuse_backend_rs::overlayfs::OverlayFs

pub struct OverlayFs { /* private fields */ }

Implementations

impl OverlayFs

pub fn new( upper: Option<Arc<BoxedLayer>>, lowers: Vec<Arc<BoxedLayer>>, params: Config, ) -> Result<Self>

pub fn root_inode(&self) -> Inode

pub fn import(&self) -> Result<()>

Trait Implementations

impl BackendFileSystem for OverlayFs

fn mount(&self) -> Result<(Entry, u64)>

mount returns the backend file system root inode entry and the largest inode number it has.

fn as_any(&self) -> &dyn Any

Provides a reference to the Any trait. This is useful to let the caller have access to the underlying type behind the trait.

impl FileSystem for OverlayFs

type Inode = u64

Represents a location in the filesystem tree and can be used to perform operations that act on the metadata of a file/directory (e.g., getattr and setattr). Can also be used as the starting point for looking up paths in the filesystem tree. An Inode may support operating directly on the content of the path that to which it points. FileSystem implementations that support this should set the FsOptions::ZERO_MESSAGE_OPEN option in the return value of the init function. On linux based systems, an Inode is equivalent to opening a file or directory with the libc::O_PATH flag.

type Handle = u64

Represents a file or directory that is open for reading/writing.

fn init(&self, capable: FsOptions) -> Result<FsOptions>

Initialize the file system.

fn destroy(&self)

Clean up the file system.

fn statfs(&self, ctx: &Context, inode: Inode) -> Result<statvfs64>

Get information about the file system.

fn lookup(&self, ctx: &Context, parent: Inode, name: &CStr) -> Result<Entry>

Look up a directory entry by name and get its attributes.

fn forget(&self, _ctx: &Context, inode: Inode, count: u64)

Forget about an inode.

fn batch_forget(&self, _ctx: &Context, requests: Vec<(Inode, u64)>)

Forget about multiple inodes.

fn opendir( &self, ctx: &Context, inode: Inode, _flags: u32, ) -> Result<(Option<Handle>, OpenOptions)>

Open a directory for reading.

fn releasedir( &self, _ctx: &Context, inode: Inode, _flags: u32, handle: Handle, ) -> Result<()>

Release an open directory.

fn mkdir( &self, ctx: &Context, parent: Inode, name: &CStr, mode: u32, umask: u32, ) -> Result<Entry>

Create a directory.

fn rmdir(&self, ctx: &Context, parent: Inode, name: &CStr) -> Result<()>

Remove a directory.

fn readdir( &self, ctx: &Context, inode: Inode, handle: Handle, size: u32, offset: u64, add_entry: &mut dyn FnMut(DirEntry<'_>) -> Result<usize>, ) -> Result<()>

Read a directory.

fn readdirplus( &self, ctx: &Context, inode: Inode, handle: Handle, size: u32, offset: u64, add_entry: &mut dyn FnMut(DirEntry<'_>, Entry) -> Result<usize>, ) -> Result<()>

Read a directory with entry attributes.

fn open( &self, ctx: &Context, inode: Inode, flags: u32, fuse_flags: u32, ) -> Result<(Option<Handle>, OpenOptions, Option<u32>)>

Open a file.

fn release( &self, ctx: &Context, _inode: Inode, flags: u32, handle: Handle, flush: bool, flock_release: bool, lock_owner: Option<u64>, ) -> Result<()>

Release an open file.

fn create( &self, ctx: &Context, parent: Inode, name: &CStr, args: CreateIn, ) -> Result<(Entry, Option<Handle>, OpenOptions, Option<u32>)>

Create and open a file.

fn unlink(&self, ctx: &Context, parent: Inode, name: &CStr) -> Result<()>

Remove a file.

fn read( &self, ctx: &Context, inode: Inode, handle: Handle, w: &mut dyn ZeroCopyWriter, size: u32, offset: u64, lock_owner: Option<u64>, flags: u32, ) -> Result<usize>

Read data from a file.

fn write( &self, ctx: &Context, inode: Inode, handle: Handle, r: &mut dyn ZeroCopyReader, size: u32, offset: u64, lock_owner: Option<u64>, delayed_write: bool, flags: u32, fuse_flags: u32, ) -> Result<usize>

Write data to a file.

fn getattr( &self, ctx: &Context, inode: Inode, handle: Option<Handle>, ) -> Result<(stat64, Duration)>

Get attributes for a file / directory.

fn setattr( &self, ctx: &Context, inode: Inode, attr: stat64, handle: Option<Handle>, valid: SetattrValid, ) -> Result<(stat64, Duration)>

Set attributes for a file / directory.

fn rename( &self, _ctx: &Context, _olddir: Inode, _odlname: &CStr, _newdir: Inode, _newname: &CStr, _flags: u32, ) -> Result<()>

Rename a file / directory.

fn mknod( &self, ctx: &Context, parent: Inode, name: &CStr, mode: u32, rdev: u32, umask: u32, ) -> Result<Entry>

Create a file node.

fn link( &self, ctx: &Context, inode: Inode, newparent: Inode, name: &CStr, ) -> Result<Entry>

Create a hard link.

fn symlink( &self, ctx: &Context, linkname: &CStr, parent: Inode, name: &CStr, ) -> Result<Entry>

Create a symbolic link.

fn readlink(&self, ctx: &Context, inode: Inode) -> Result<Vec<u8>>

Read a symbolic link.

fn flush( &self, ctx: &Context, inode: Inode, handle: Handle, lock_owner: u64, ) -> Result<()>

Flush the contents of a file.

fn fsync( &self, ctx: &Context, inode: Inode, datasync: bool, handle: Handle, ) -> Result<()>

Synchronize file contents.

fn fsyncdir( &self, ctx: &Context, inode: Inode, datasync: bool, handle: Handle, ) -> Result<()>

Synchronize the contents of a directory.

fn access(&self, ctx: &Context, inode: Inode, mask: u32) -> Result<()>

Check file access permissions.

fn setxattr( &self, ctx: &Context, inode: Inode, name: &CStr, value: &[u8], flags: u32, ) -> Result<()>

Set an extended attribute.

fn getxattr( &self, ctx: &Context, inode: Inode, name: &CStr, size: u32, ) -> Result<GetxattrReply>

Get an extended attribute.

fn listxattr( &self, ctx: &Context, inode: Inode, size: u32, ) -> Result<ListxattrReply>

List extended attribute names.

fn removexattr(&self, ctx: &Context, inode: Inode, name: &CStr) -> Result<()>

Remove an extended attribute.

fn fallocate( &self, ctx: &Context, inode: Inode, handle: Handle, mode: u32, offset: u64, length: u64, ) -> Result<()>

Allocate requested space for file data.

fn lseek( &self, ctx: &Context, inode: Inode, handle: Handle, offset: u64, whence: u32, ) -> Result<u64>

Reposition read/write file offset.

fn getlk( &self, ctx: &Context, inode: Self::Inode, handle: Self::Handle, owner: u64, lock: FileLock, flags: u32, ) -> Result<FileLock>

Query file lock status

fn setlk( &self, ctx: &Context, inode: Self::Inode, handle: Self::Handle, owner: u64, lock: FileLock, flags: u32, ) -> Result<()>

Grab a file read lock

fn setlkw( &self, ctx: &Context, inode: Self::Inode, handle: Self::Handle, owner: u64, lock: FileLock, flags: u32, ) -> Result<()>

Grab a file write lock

fn ioctl( &self, ctx: &Context, inode: Self::Inode, handle: Self::Handle, flags: u32, cmd: u32, data: IoctlData<'_>, out_size: u32, ) -> Result<IoctlData<'_>>

send ioctl to the file

fn bmap( &self, ctx: &Context, inode: Self::Inode, block: u64, blocksize: u32, ) -> Result<u64>

Query a file’s block mapping info

fn poll( &self, ctx: &Context, inode: Self::Inode, handle: Self::Handle, khandle: Self::Handle, flags: u32, events: u32, ) -> Result<u32>

Poll a file’s events

fn notify_reply(&self) -> Result<()>

TODO: support this

fn id_remap(&self, ctx: &mut Context) -> Result<()>

Remap the external IDs in context to internal IDs.