Compukters Core/compukter.filesystem/Path

Path

value class Path(val value: String)(source)

An immutable absolute lexical path, independent of storage and native capabilities.

Constructors

Path

constructor(value: String)

Properties

name

val name: String?

parent

val parent: Path?

value

val value: String

Functions

createDirectories

fun Path.createDirectories()

createDirectory

fun Path.createDirectory()

delete

fun Path.delete()

deleteIfExists

fun Path.deleteIfExists(): Boolean

list

fun Path.list(maximumEntries: Int = 256): List<Path>

moveTo

fun Path.moveTo(destination: Path)

fun Path.moveTo(destination: Path, replaceExisting: Boolean)

normalize

fun normalize(): Path

Removes dot components without accessing storage; attempts to ascend above root stay at root.

openDirectory

fun Path.openDirectory(): DirectoryReader

openRead

fun Path.openRead(): FileReader

openWrite

fun Path.openWrite(): AtomicFileWriter

readBytes

fun Path.readBytes(maximumBytes: Int = 65536): ByteArray

readLines

fun Path.readLines(maximumBytes: Int = 65536): List<String>

Reads all lines within the encoded file-size bound; see FileSystem.readLines.

readText

fun Path.readText(maximumBytes: Int = 65536): String

resolve

fun resolve(relative: String): Path

Combines this explicit base with a relative path without normalizing dot components or accessing storage.

stat

fun Path.stat(): FileInfo

Optional storage conveniences. Every operation delegates to the explicit FileSystem facade.

statOrNull

fun Path.statOrNull(): FileInfo?

toString

open override fun toString(): String

useLines

inline fun <R> Path.useLines(maximumLineBytes: Int = 65536, block: (Sequence<String>) -> R): R

Processes a scoped single-pass sequence, closing on every exit; see FileSystem.useLines.

writeBytes

fun Path.writeBytes(contents: ByteArray)

writeText

fun Path.writeText(contents: String)