engine/elide.runtime.vfs/LanguageVFS

LanguageVFS

Guest: Language-virtual Filesystem

Describes the API surface of a guest language-specific virtual file system (VFS) implementation. The VFS system is aware of language VFS bindings, and provides these bindings in the event the corresponding language is requested for use in Elide.

Language-specific VFS implementations declare their languageId.

Types

LanguageVFSInfo

interface LanguageVFSInfo

Describes a configured language-level virtual file system; this includes a fsProvider which can be used to obtain the VFS implementation, and a router function which decides if a path is eligible to be handled by the VFS.

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.

languageId

abstract val languageId: String

Well-known ID of the language which this VFS implementation is associated with.

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

accepts

abstract fun accepts(path: Path): Boolean

Returns true if this VFS implementation should claim access to the provided path.

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