graalvm/elide.runtime.gvm.internals.vfs/EmbeddedGuestVFSImpl/Builder

Builder

data class Builder(var deferred: Boolean = Settings.DEFAULT_DEFERRED_READS, var readOnly: Boolean = true, var caseSensitive: Boolean = true, var enableSymlinks: Boolean = false, var root: String = ROOT_SYSTEM_DEFAULT, var workingDirectory: String = DEFAULT_CWD, var policy: GuestVFSPolicy = GuestVFSPolicy.DEFAULTS, var registry: MutableMap<String, EmbeddedGuestVFSImpl.VfsObjectInfo> = mutableMapOf(), var bundleMapping: MutableMap<Int, EmbeddedGuestVFSImpl.BundleInfo> = mutableMapOf(), bundle: Pair<FilesystemInfo, FileSystem>? = null, paths: List<URI> = emptyList(), files: List<File> = emptyList(), zip: URI? = null, file: URI? = null) : AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Builder to configure and spawn new embedded VFS implementations.

Builders can be filled out property-wise, or via builder methods.

Parameters

deferred

Whether to defer reading of files into the VFS until they are requested.

readOnly

Whether the file-system should be considered read-only (regardless of backing read-only status).

caseSensitive

Whether the file-system should be considered case-sensitive.

enableSymlinks

Whether to enable support for symbolic links.

root

Root directory of the file-system.

workingDirectory

Working directory of the file-system.

policy

Policy to apply to moderate guest I/O access to the file-system in question.

registry

Registry of known file paths which are consulted for deferred reads.

bundleMapping

Mapping of bundle IDs to bundle metadata; consulted for deferred reads.

bundle

Bundle file to load the file-system from.

paths

Paths to the bundle files, as regular host-filesystem paths, or classpath:-prefixed URIs for resources which should be fetched from the host app class-path.

files

Files to load as file-system bundles.

Constructors

Builder

constructor(deferred: Boolean = Settings.DEFAULT_DEFERRED_READS, readOnly: Boolean = true, caseSensitive: Boolean = true, enableSymlinks: Boolean = false, root: String = ROOT_SYSTEM_DEFAULT, workingDirectory: String = DEFAULT_CWD, policy: GuestVFSPolicy = GuestVFSPolicy.DEFAULTS, registry: MutableMap<String, EmbeddedGuestVFSImpl.VfsObjectInfo> = mutableMapOf(), bundleMapping: MutableMap<Int, EmbeddedGuestVFSImpl.BundleInfo> = mutableMapOf(), bundle: Pair<FilesystemInfo, FileSystem>? = null, paths: List<URI> = emptyList(), files: List<File> = emptyList(), zip: URI? = null, file: URI? = null)

Types

Factory

object Factory : AbstractBaseVFS.VFSBuilderFactory<EmbeddedGuestVFSImpl, EmbeddedGuestVFSImpl.Builder>

Factory for embedded VFS implementations.

Properties

bundleMapping

open override var bundleMapping: MutableMap<Int, EmbeddedGuestVFSImpl.BundleInfo>

caseSensitive

open override var caseSensitive: Boolean

deferred

open override var deferred: Boolean

enableSymlinks

open override var enableSymlinks: Boolean

policy

open override var policy: GuestVFSPolicy

readOnly

open override var readOnly: Boolean

registry

open override var registry: MutableMap<String, EmbeddedGuestVFSImpl.VfsObjectInfo>

root

open override var root: String

workingDirectory

open override var workingDirectory: String

Functions

build

open override fun build(): EmbeddedGuestVFSImpl

Collect all the current settings, apply defaults where needed, and construct the requested VFS implementation.

setBundle

fun setBundle(bundle: Pair<FilesystemInfo, FileSystem>): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

fun setBundle(bundle: Triple<FilesystemInfo, FileSystem, Map<Int, EmbeddedGuestVFSImpl.BundleInfo>>): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the bundle to use directly (pre-loaded from some data source).

setBundleFiles

fun setBundleFiles(files: List<File>): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the files to load the bundle data from; expected to be a valid and readable regular file, which is a tarball, a compressed tar-ball, or a bundle in Elide's internal format.

setBundleMapping

open fun setBundleMapping(bundles: Map<Int, EmbeddedGuestVFSImpl.BundleInfo>): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the bundles which should be consulted for deferred reads.

setBundlePaths

fun setBundlePaths(paths: List<URI>): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the paths to load the bundle file from; can be a regular file-path, or a classpath:-prefixed path to load a resource from the host app classpath.

setCaseSensitive

open fun setCaseSensitive(caseSensitive: Boolean): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the caseSensitive status of the file-system managed by this VFS implementation.

setDeferred

open fun setDeferred(deferred: Boolean): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the deferred status of the file-system managed by this VFS implementation.

setEnableSymlinks

open fun setEnableSymlinks(enableSymlinks: Boolean): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the enableSymlinks setting of the file-system managed by this VFS implementation.

setFileTarget

fun setFileTarget(target: File): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

fun setFileTarget(target: URI): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

fun setFileTarget(target: Path): AbstractBaseVFS.VFSBuilder<EmbeddedGuestVFSImpl>

Set the target file to load the bundle data from; expected to be a valid and readable/writable regular file, and it will be created if it doesn't exist.

setPolicy