org.cryptomator.frontend.fuse.FuseNioAdapter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fuse-nio-adapter Show documentation

Access resources at a given NIO path via FUSE.

There is a newer version: 5.0.2

package org.cryptomator.frontend.fuse;

import org.cryptomator.jfuse.api.FuseOperations;

import java.io.IOException;

public interface FuseNioAdapter extends FuseOperations, AutoCloseable {

	/**
	 * The default value for the maximum supported filename length.
	 */
	int DEFAULT_MAX_FILENAMELENGTH = 254; // 255 is preferred, but nautilus checks for this value + 1

	/**
	 * Checks if the filesystem is in use (and therefore an unmount attempt should be avoided).
	 * 
	 * Important: This function only checks, like the name suggests, if the filesystem is busy and used. A return value of {@code false} should not be considered as an unmount can be safely and successfully executed and thus an unmount may fail.
	 * 
	 * API note: It is the task of the fs developer to decide what "in use" means. For example, "in use" can mean there are open resources or pending operations.
	 * Additionally no guarantees about the validity of the result after the call is made, i.e. the result may be immediately outdated.
	 *
	 * @return true if the filesystem is in use
	 */
	boolean isInUse();

	@Override
	void close() throws IOException;
}