quarkdown-core/com.quarkdown.core.filesystem/FsEntry

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.

Entries are created via FileSystem.resolve or derived from other entries (resolve, parent, children).

Properties

canonical

val canonical: FsEntry

This entry with symbolic links resolved, if it exists; falls back to its absolute, normalized form otherwise.

exists

val exists: Boolean

Whether this entry exists.

extension

val extension: String

The file extension, without the leading dot, or an empty string if there is none.

fullPath

val fullPath: String

The full path string of this entry, suitable for display and error messages.

invariantSeparatorsPath

val invariantSeparatorsPath: String

fullPath with / as the separator on every platform, suitable for URLs.

isAbsolute

val isAbsolute: Boolean

Whether this entry's path is absolute.

isDirectory

val isDirectory: Boolean

Whether this entry exists and is a directory.

isFile

val isFile: Boolean

Whether this entry exists and is a regular file.

lastModifiedAtMillis

val lastModifiedAtMillis: Long?

The last modification timestamp in epoch milliseconds, if available.

name

val name: String

The file or directory name, including any extension.

nameWithoutExtension

val nameWithoutExtension: String

The file name without its last extension.

normalized

val normalized: FsEntry

This entry with redundant path segments (., ..) resolved lexically.

parent

val parent: FsEntry?

The parent entry, or null if this entry has no parent.

Functions

children

fun children(): List<FsEntry>

Lists the direct children of this directory entry.

descendants

fun descendants(): Sequence<FsEntry>

Walks this directory entry recursively.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isSubPathOf

fun isSubPathOf(ancestor: FsEntry): Boolean

Whether this entry is located in ancestor or any of its subdirectories. Both paths are canonicalized when possible, so a symbolic link inside ancestor pointing outside it is correctly detected as not being a sub-path.

readBytes

fun readBytes(): ByteArray

readLines

fun readLines(): List<String>

readText

fun readText(): String

relativeTo

fun relativeTo(other: FsEntry): FsEntry?

Computes this entry's path relative to other.

resolve

fun resolve(child: String): FsEntry

Resolves a child path against this entry.

toFileOrNull

fun toFileOrNull(): File?

Converts this entry to a File, if it is backed by the physical disk file system. This is the boundary between the platform-neutral input abstraction and JVM-only output or process-level code; input-side code must not use it.

toOutputResource

fun FsEntry.toOutputResource(name: String = this.name, useChecksumInvalidation: Boolean = false, symlink: Boolean = false): OutputResource

Converts this entry to an OutputResource for the pipeline to output.

toString

open override fun toString(): String