Package-level declarations

Types

Link copied to clipboard
class DiskFileSystem(workingDirectory: File? = null) : OkioBackedFileSystem

A FileSystem backed by the physical disk file system. This is the default file system used by the pipeline and the CLI.

Link copied to clipboard
interface FileSystem

A file system abstraction which can retrieve files, either absolutely or relative to a working directory.

Link copied to clipboard
class FsEntry

A platform-neutral handle to a file or directory, bound to the FileSystem backend that created it. An entry provides path math, existence and metadata queries, content reading, and directory listing, without exposing the underlying I/O engine.

Link copied to clipboard
object FsPaths

Utilities for raw path strings, backing checks that do not require a FileSystem.

Link copied to clipboard

Base class for the public FileSystem entry points (DiskFileSystem, VirtualFileSystem), which are always root file systems and delegate their behavior to the internal OkioFileSystem engine, while acting themselves as the lineage root of their branches.

Link copied to clipboard

Types of granularity for determining the root of the file system.

Link copied to clipboard

An in-memory FileSystem, detached from the physical disk. Entries produced by this file system return null from FsEntry.toFileOrNull.

Functions

Link copied to clipboard
fun Context.getRootFileSystem(granularity: RootGranularity = RootGranularity.PROJECT): FileSystem?

Retrieves the relative path to the root of the file system. The root of the file system is determined by the working directory of the current subdocument.