korlibs-io-vfs/korlibs.io.file

Package-level declarations

Types

data class FinalVfsFile(val file: VfsFile)

interface Path

inline class PathInfo(val fullPath: String)

abstract class Vfs : AsyncCloseable

VfsCachedStatContext

class VfsCachedStatContext(val stat: VfsStat?) : CoroutineContext.Element

data class VfsFile(val vfs: Vfs, val path: String) : VfsNamed, AsyncInputOpenable, Extra

open class VfsNamed(val pathInfo: PathInfo) : Path

enum VfsOpenMode : Enum<VfsOpenMode>

VfsProcessException

class VfsProcessException(message: String) : IOException

VfsProcessHandler

open class VfsProcessHandler

data class VfsStat(val file: VfsFile, val exists: Boolean, val isDirectory: Boolean, val size: Long, val device: Long = -1L, val inode: Long = -1L, val mode: Int = 511, val owner: String = "nobody", val group: String = "nobody", val createTime: DateTime = DateTime.EPOCH, val modifiedTime: DateTime = createTime, val lastAccessTime: DateTime = modifiedTime, val extraInfo: Any? = null, val kind: Vfs.FileKind? = null, val id: String? = null, val exception: Throwable? = null) : Path

Properties

val Path.baseName: String

val PathInfo.baseName: String

/path\to/file.ext -> file.ext

baseNameWithoutCompoundExtension

val Path.baseNameWithoutCompoundExtension: String

val PathInfo.baseNameWithoutCompoundExtension: String

/path\to/file.1.ext -> file

baseNameWithoutExtension

val Path.baseNameWithoutExtension: String

val PathInfo.baseNameWithoutExtension: String

/path\to/file.1.ext -> file.1

compoundExtension

val Path.compoundExtension: String

val PathInfo.compoundExtension: String

/path\to/file.1.EXT -> 1.EXT

compoundExtensionLC

val Path.compoundExtensionLC: String

val PathInfo.compoundExtensionLC: String

/path\to/file.1.EXT -> 1.ext

val VfsStat.createDate: DateTime

val Path.extension: String

val PathInfo.extension: String

/path\to/file.1.EXT -> EXT

val Path.extensionLC: String

val PathInfo.extensionLC: String

/path\to/file.1.EXT -> ext

File_pathSeparatorChar

val File_pathSeparatorChar: Char

File_separatorChar

val File_separatorChar: Char

val Path.folder: String

val PathInfo.folder: String

/path\to/file.ext -> /path\to

folderWithSlash

val Path.folderWithSlash: String

val PathInfo.folderWithSlash: String

/path\to/file.ext -> /path/to/

val Path.fullName: String

val PathInfo.fullName: String

/path\to/file.1.ext -> /path\to/file.1.ext

fullNameWithoutCompoundExtension

val Path.fullNameWithoutCompoundExtension: String

val PathInfo.fullNameWithoutCompoundExtension: String

/path\to/file.1.ext -> file

fullNameWithoutExtension

val Path.fullNameWithoutExtension: String

val PathInfo.fullNameWithoutExtension: String

/path\to/file.1.ext -> /path\to/file.1

fullPathNormalized

val Path.fullPathNormalized: String

val PathInfo.fullPathNormalized: String

/path\to/file.ext -> /path/to/file.ext

fullPathWithoutExtension

val Path.fullPathWithoutExtension: String

val PathInfo.fullPathWithoutExtension: String

/path\to/file.ext -> /path\to/file

val VfsStat.lastAccessDate: DateTime

val VfsStat.modifiedDate: DateTime

val PathInfo.parent: PathInfo

/path\to/file.ext -> /path\to

val String.pathInfo: PathInfo

Functions

baseNameWithCompoundExtension

fun Path.baseNameWithCompoundExtension(ext: String): String

fun PathInfo.baseNameWithCompoundExtension(ext: String): String

/path\to/file.1.ext -> file.newext

baseNameWithExtension

fun Path.baseNameWithExtension(ext: String): String

fun PathInfo.baseNameWithExtension(ext: String): String

/path\to/file.1.ext -> file.1.newext

fun PathInfo.combine(access: PathInfo): PathInfo

deleteRecursively

suspend fun VfsFile.deleteRecursively(includeSelf: Boolean = true)

Deletes all the files in this folder recursively. If the entry is a file instead of a directory, the file is deleted.

fullPathWithExtension

fun Path.fullPathWithExtension(ext: String): String

fun PathInfo.fullPathWithExtension(ext: String): String

/path\to/file.ext -> /path\to/file.newext

getPathComponents

fun Path.getPathComponents(): List<String>

fun PathInfo.getPathComponents(): List<String>

/path\to/file.1.ext -> listOf("", "path", "to", "file.1.ext")

getPathFullComponents

fun Path.getPathFullComponents(): List<String>

fun PathInfo.getPathFullComponents(): List<String>

/path\to/file.1.ext -> listOf("/path", "/path/to", "/path/to/file.1.ext")

getUnderlyingUnscapedFile

suspend fun VfsFile.getUnderlyingUnscapedFile(): FinalVfsFile

getUnixPermission

inline suspend fun VfsFile.getUnixPermission(): Vfs.UnixPermissions

fun PathInfo.isAbsolute(): Boolean

fun VfsFile.jail(): VfsFile

fun VfsFile.jailParent(): VfsFile

fun PathInfo.lightCombine(access: PathInfo): PathInfo

fun PathInfo.normalize(removeEndSlash: Boolean = true): String

normalizeAbsolute

fun PathInfo.normalizeAbsolute(): PathInfo

fun PathInfo.parts(): List<String>

fun VfsFile.proxied(transform: suspend (VfsFile) -> VfsFile): VfsFile

readAsSyncStream

suspend fun VfsFile.readAsSyncStream(): SyncStream

fun PathInfo.relativePathTo(relative: PathInfo): String?

setUnixPermission

inline suspend fun VfsFile.setUnixPermission(permissions: Vfs.UnixPermissions)

fun FinalVfsFile.toFile(): VfsFile

fun VfsFile.toUnscaped(): FinalVfsFile

suspend fun <R> VfsFile.useVfs(callback: suspend (VfsFile) -> R): R

fun VfsFile.withOnce(once: suspend (VfsFile) -> Unit): VfsFile