Module org.cryptomator.jfuse.api

Package org.cryptomator.jfuse.api

Interface DirFiller

public interface DirFiller

The DirFiller will be used during readdir requests and needs to be invoked by file system implementations once for every child of the read dir.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FUSE_FILL_DIR_PLUS	"Plus" mode: all file attributes are valid.

Method Summary

Modifier and Type	Method	Description
default void	fill(String name)	Convenienve wrapper for fill(String, Consumer, long, int), just filling in the name, ignoring stats.
default void	fill(String name, Consumer<Stat> stat)	Convenience wrapper for fill(String, Consumer, long, int), ignoring the offset parameter.
int	fill(String name, Consumer<Stat> stat, long offset, int flags)	Function to add an entry in a readdir() operation

Field Details

FUSE_FILL_DIR_PLUS

static final int FUSE_FILL_DIR_PLUS

"Plus" mode: all file attributes are valid.

The attributes are used by the kernel to prefill the inode cache during a readdir.

It is okay to set FUSE_FILL_DIR_PLUS if FUSE_READDIR_PLUS is not set and vice versa.

See Also:

• Constant Field Values

Method Details

fill

int fill(String name,
 Consumer<Stat> stat,
 long offset,
 int flags)

Function to add an entry in a readdir() operation

The off parameter can be any non-zero value that enables the filesystem to identify the current point in the directory stream. It does not need to be the actual physical position. A value of zero is reserved to indicate that seeking in directories is not supported.

Parameters:

name - the file name of the directory entry

stat - file attributes, can be NULL

offset - offset of the next entry or zero when ignoring the offset parameter

flags - fill flags, set to FUSE_FILL_DIR_PLUS to cache stats

Returns:

1 if buffer is full or an error occured, zero otherwise

See Also:

• official readdir docs
• readdir explanation from Geoff Kuenning

fill

default void fill(String name,
 Consumer<Stat> stat)
           throws IOException

Convenience wrapper for fill(String, Consumer, long, int), ignoring the offset parameter.

Parameters:

name - The file name

stat - A method to pre-fill the stats of this node

Throws:

IOException - If fuse_fill_dir_t returns 1, which indicates an error.

fill

default void fill(String name)
           throws IOException

Convenienve wrapper for fill(String, Consumer, long, int), just filling in the name, ignoring stats.

Parameters:

name - The file name

Throws:

IOException - If fuse_fill_dir_t returns 1, which indicates an error.