filesystem/me.zhanghai.kotlin.filesystem/Path

Path

class Path : Comparable<Path>

A hierarchical identifier for a file in a file system.

A path consists of a root URI and a list of names. The root URI identifies the root of the file hierarchy, including the file system which is identified by the scheme of the root URI. The list of names identifies the file within its file hierarchy, and each name is a non-empty byte string that doesn't contain the URI path separator /.

As such, a path is always absolute, and a relative identifier consisting of only a list of names is represented by a RelativePath.

A path is an immutable data object independent of file systems, and can be converted to/from a URI for presentation and serialization.

See also

Types

object Companion

Properties

val fileName: ByteString?

The file name of this path, which is the last name in the list of names.

var fileSystemTag: Any?

A tag for use by the implementation of the file system identified by this path.

val names: List<ByteString>

The list of names of this path.

val rootUri: Uri

The root URI of this path.

val scheme: String

The scheme of the root URI of this path.

Functions

inline suspend fun Path.checkAccess(vararg modes: AccessMode)

open operator override fun compareTo(other: Path): Int

inline suspend fun Path.copyTo(target: Path, vararg options: CopyFileOption)

createDirectory

inline suspend fun Path.createDirectory(vararg options: CreateFileOption)

createHardLinkTo

inline suspend fun Path.createHardLinkTo(existing: Path)

createSymbolicLinkTo

inline suspend fun Path.createSymbolicLinkTo(target: ByteString, vararg options: CreateFileOption)

inline suspend fun Path.delete()

inline suspend fun Path.deleteIfExists(): Boolean

fun endsWith(other: RelativePath): Boolean

Check whether this path ends with a relative path.

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

inline suspend fun Path.exists(noFollowLinks: Boolean = false): Boolean

fun getParent(): Path?

Get a path for the parent of the file this path is identifying, or null if this path identifies the root of its file hierarchy.

fun getRoot(): Path

Get a path for the root of the file hierarchy this path is identifying.

open override fun hashCode(): Int

inline suspend fun Path.isAccessible(vararg modes: AccessMode): Boolean

inline suspend fun Path.isSameFileAs(other: Path): Boolean

inline suspend fun Path.moveTo(target: Path, vararg options: CopyFileOption)

fun normalize(): Path

Get a path that is this path with redundant names removed.

inline suspend fun Path.notExists(noFollowLinks: Boolean = false): Boolean

inline suspend fun Path.openContent(vararg options: FileContentOption): FileContent

openDirectoryStream

inline suspend fun Path.openDirectoryStream(vararg options: DirectoryStreamOption): DirectoryStream

inline suspend fun Path.openFileStore(): FileStore

openMetadataView

inline suspend fun Path.openMetadataView(vararg options: FileMetadataOption): FileMetadataView

inline suspend fun Path.openSink(vararg options: FileContentOption = FileSystem.OPEN_SINK_OPTIONS_DEFAULT): AsyncSink

inline suspend fun Path.openSource(vararg options: FileContentOption): AsyncSource

inline suspend fun Path.readDirectory(vararg options: DirectoryStreamOption): List<Path>

inline suspend fun Path.readMetadata(vararg options: FileMetadataOption): FileMetadata

readSymbolicLink

inline suspend fun Path.readSymbolicLink(): ByteString

fun relativize(other: Path): RelativePath

Get a relative path between this path and another path.

requireFileSystem

fun Path.requireFileSystem(): FileSystem

fun resolve(fileName: ByteString): Path

Resolve a file name against this path.

fun resolve(other: RelativePath): Path

Resolve a relative path against this path.

fun resolveSibling(fileName: ByteString): Path

Resolve a file name against the parent of this path.

fun startsWith(other: Path): Boolean

Check whether this path starts with another path.

fun subPath(endIndex: Int): Path

Get a path consisting of a sublist of names of this path.

fun Path.toPlatformPath(): ByteString

toPlatformPathString

fun Path.toPlatformPathString(): String

inline suspend fun Path.toRealPath(): Path

fun toRelativePath(startIndex: Int = 0, endIndex: Int = names.size): RelativePath

Get a relative path consisting of a sublist of names of this path.

open override fun toString(): String

fun toUri(): Uri

Get a URI representing this path.