engine/elide.runtime.vfs/GuestVFS

GuestVFS

interface GuestVFS : FileSystem, Closeable, AutoCloseable

Guest: Virtual Filesystem

Describes the API surface of a guest virtual file system (VFS) implementation. The VFS system is used to fully virtualize and isolate I/O for guest languages running within an Elide application. By default, the guest VFS implementation functions as a read-only, TAR-backed file system.

If desired, the VFS implementation can be replaced by one which accesses host I/O facilities directly (via flags, configuration, and so on).

Inheritors

LanguageVFS

Types

VFSConfigurator

interface VFSConfigurator

Implementations of this interface are accessed via dependency injection at the time a VFS configuration is created, so that they may participate in configuration of the VFS implementation. This entrypoint is typically only for internal use.

Properties

compound

abstract val compound: Boolean

Indicates whether this VFS implementation is backed by multiple layers.

deletable

abstract val deletable: Boolean

Indicates whether this VFS implementation allows deletion of files from the virtual file system.

host

abstract val host: Boolean

Indicates whether this VFS implementation is backed by host I/O facilities.

supportsSymlinks

abstract val supportsSymlinks: Boolean

Indicates whether this VFS implementation supports symbolic links.

virtual

abstract val virtual: Boolean

Indicates whether this VFS implementation is virtualized.

writable

abstract val writable: Boolean

Indicates whether this VFS implementation allows writes to the virtual file system.

Functions

allowsHostFileAccess

abstract fun allowsHostFileAccess(): Boolean

Indicates whether this VFS implementation allows access to host-side I/O for regular files on-disk. Unless I/O for guest->host access is enabled, this is always false.

allowsHostSocketAccess

abstract fun allowsHostSocketAccess(): Boolean

Indicates whether this VFS implementation allows access to host-side I/O for native sockets. Unless I/O for guest->host access is enabled, this is always false.

checkAccess

abstract fun checkAccess(path: Path, modes: MutableSet<out AccessMode>, vararg linkOptions: LinkOption)

abstract override fun close()

copy

open fun copy(source: Path, target: Path, vararg options: CopyOption)

createDirectory

abstract fun createDirectory(dir: Path, vararg attrs: FileAttribute<*>)

createLink

open fun createLink(link: Path, existing: Path)

createSymbolicLink

open fun createSymbolicLink(link: Path, target: Path, vararg attrs: FileAttribute<*>)

delete

abstract fun delete(path: Path)

existsAny

open fun existsAny(path: Path): Boolean

Determine whether the path provided exists in this VFS, considering lazy reads and other deferred activity; the default implementation simply delegates to Files.exists.

getEncoding