filesystem/me.zhanghai.kotlin.filesystem

Package-level declarations

Types

AccessDeniedException

expect class AccessDeniedException : FileSystemException

actual typealias AccessDeniedException = <Error class: unknown class>

actual class AccessDeniedException : FileSystemException

AccessMode

expect enum AccessMode : Enum<AccessMode>

Access modes for checking the accessibility of a file.

actual typealias AccessMode = <Error class: unknown class>

actual enum AccessMode : Enum<AccessMode>

AtomicMoveNotSupportedException

expect class AtomicMoveNotSupportedException : FileSystemException

actual typealias AtomicMoveNotSupportedException = <Error class: unknown class>

actual class AtomicMoveNotSupportedException : FileSystemException

BasicCopyFileOption

enum BasicCopyFileOption : Enum<BasicCopyFileOption> , CopyFileOption

Basic options for copying or moving a file.

BasicDirectoryStreamOption

enum BasicDirectoryStreamOption : Enum<BasicDirectoryStreamOption> , DirectoryStreamOption

Basic options for opening a directory stream.

BasicFileContentOption

enum BasicFileContentOption : Enum<BasicFileContentOption> , FileContentOption

Basic options for opening content of a file.

CopyFileOption

interface CopyFileOption

Options for copying or moving a file.

CreateFileOption

interface CreateFileOption : FileContentOption

Options for creating a file.

DirectoryEntry

interface DirectoryEntry

A directory entry.

DirectoryEntryWithMetadata

interface DirectoryEntryWithMetadata : DirectoryEntryWithType

A directory entry with additional file metadata information.

DirectoryEntryWithType

interface DirectoryEntryWithType : DirectoryEntry

A directory entry with additional file type information.

DirectoryNotEmptyException

expect class DirectoryNotEmptyException : FileSystemException

actual typealias DirectoryNotEmptyException = <Error class: unknown class>

actual class DirectoryNotEmptyException : FileSystemException

DirectoryStream

interface DirectoryStream : AsyncCloseable

A stream of entries in a directory.

DirectoryStreamOption

interface DirectoryStreamOption

Options for opening a directory stream.

FileAlreadyExistsException

expect class FileAlreadyExistsException : FileSystemException

actual typealias FileAlreadyExistsException = <Error class: unknown class>

actual class FileAlreadyExistsException : FileSystemException

FileContent

interface FileContent : AsyncCloseable

FileContentOption

interface FileContentOption

Options for opening content of a file.

FileMetadata

interface FileMetadata

FileMetadataOption

interface FileMetadataOption

Options for opening or reading metadata of a file.

FileMetadataView

interface FileMetadataView : AsyncCloseable

FileStore

interface FileStore : AsyncCloseable

FileStoreMetadata

interface FileStoreMetadata

FileSystem

interface FileSystem

FileSystemException

expect open class FileSystemException : IOException

actual typealias FileSystemException = <Error class: unknown class>

actual open class FileSystemException : IOException

FileSystemLoopException

expect class FileSystemLoopException : FileSystemException

actual typealias FileSystemLoopException = <Error class: unknown class>

actual class FileSystemLoopException : FileSystemException

FileSystemRegistry

object FileSystemRegistry

A registry for file systems.

FileTime

expect class FileTime : Comparable<FileTime>

actual typealias FileTime = <Error class: unknown class>

actual class FileTime(val millis: Long, val excessNanos: Long) : Comparable<FileTime>

FileType

enum FileType : Enum<FileType>

LinkOption

enum LinkOption : Enum<LinkOption> , FileContentOption, FileMetadataOption

Options for handling a symbolic link.

NoSuchFileException

expect class NoSuchFileException : FileSystemException

actual typealias NoSuchFileException = <Error class: unknown class>

actual class NoSuchFileException : FileSystemException

NotDirectoryException

expect class NotDirectoryException : FileSystemException

actual typealias NotDirectoryException = <Error class: unknown class>

actual class NotDirectoryException : FileSystemException

NotLinkException

expect class NotLinkException : FileSystemException

actual typealias NotLinkException = <Error class: unknown class>

actual class NotLinkException : FileSystemException

Path

class Path : Comparable<Path>

A hierarchical identifier for a file in a file system.

PlatformFileSystem

interface PlatformFileSystem : FileSystem

RelativePath

@JvmInline

value class RelativePath : Comparable<RelativePath>

A relative hierarchical identifier that can be resolved against a path.

Uri

class Uri : Comparable<Uri>

Properties

file

val FileSystemException.file: String?

otherFile

val FileSystemException.otherFile: String?

platformFileSystem

val FileSystemRegistry.platformFileSystem: PlatformFileSystem?

The registered platform file system, or null if none is registered.

reason

val FileSystemException.reason: String?

Functions

AccessDeniedException

expect fun AccessDeniedException(file: String? = null, otherFile: String? = null, reason: String? = null, cause: Throwable? = null): AccessDeniedException

actual fun AccessDeniedException(file: String?, otherFile: String?, reason: String?, cause: Throwable?): AccessDeniedException

AtomicMoveNotSupportedException

expect fun AtomicMoveNotSupportedException(source: String? = null, target: String? = null, reason: String? = null, cause: Throwable? = null): AtomicMoveNotSupportedException

actual fun AtomicMoveNotSupportedException(source: String?, target: String?, reason: String?, cause: Throwable?): AtomicMoveNotSupportedException

checkAccess

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

copyTo

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)

delete

inline suspend fun Path.delete()

deleteIfExists

inline suspend fun Path.deleteIfExists(): Boolean

DirectoryNotEmptyException

expect fun DirectoryNotEmptyException(directory: String? = null, reason: String? = null, cause: Throwable? = null): DirectoryNotEmptyException

actual fun DirectoryNotEmptyException(directory: String?, reason: String?, cause: Throwable?): DirectoryNotEmptyException

exists

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

FileAlreadyExistsException

expect fun FileAlreadyExistsException(file: String? = null, otherFile: String? = null, reason: String? = null, cause: Throwable? = null): FileAlreadyExistsException

actual fun FileAlreadyExistsException(file: String?, otherFile: String?, reason: String?, cause: Throwable?): FileAlreadyExistsException

FileSystemException

expect fun FileSystemException(file: String? = null, otherFile: String? = null, reason: String? = null, cause: Throwable? = null): FileSystemException

actual fun FileSystemException(file: String?, otherFile: String?, reason: String?, cause: Throwable?): FileSystemException

FileSystemLoopException

expect fun FileSystemLoopException(file: String? = null, reason: String? = null, cause: Throwable? = null): FileSystemLoopException

actual fun FileSystemLoopException(file: String?, reason: String?, cause: Throwable?): FileSystemLoopException

fromPlatformPath

fun Path.Companion.fromPlatformPath(platformPath: String): Path

fun Path.Companion.fromPlatformPath(platformPath: ByteString): Path

isAccessible

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

isSameFileAs

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

moveTo

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

NoSuchFileException

expect fun NoSuchFileException(file: String? = null, otherFile: String? = null, reason: String? = null, cause: Throwable? = null): NoSuchFileException

actual fun NoSuchFileException(file: String?, otherFile: String?, reason: String?, cause: Throwable?): NoSuchFileException

NotDirectoryException

expect fun NotDirectoryException(file: String? = null, reason: String? = null, cause: Throwable? = null): NotDirectoryException

actual fun NotDirectoryException(file: String?, reason: String?, cause: Throwable?): NotDirectoryException

notExists

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

NotLinkException

expect fun NotLinkException(file: String? = null, otherFile: String? = null, reason: String? = null, cause: Throwable? = null): NotLinkException

actual fun NotLinkException(file: String?, otherFile: String?, reason: String?, cause: Throwable?): NotLinkException

openContent

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

openDirectoryStream

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

openFileStore

inline suspend fun Path.openFileStore(): FileStore

openMetadataView

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

openSink

fun FileContent.openSink(position: Long = 0): AsyncSink

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

openSource

fun FileContent.openSource(position: Long = 0): AsyncSource

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

readDirectory

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

readMetadata

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

readSymbolicLink

inline suspend fun Path.readSymbolicLink(): ByteString

requireFileSystem

fun Path.requireFileSystem(): FileSystem

fun FileSystemRegistry.requireFileSystem(scheme: String): FileSystem

Get a registered file system for a URI scheme, or throw an exception if none is registered.

requirePlatformFileSystem

fun FileSystemRegistry.requirePlatformFileSystem(): PlatformFileSystem

Get the registered platform file system, or throw an exception if none is registered.

toPlatformPath

fun Path.toPlatformPath(): ByteString

toPlatformPathString

fun Path.toPlatformPathString(): String

toRealPath

inline suspend fun Path.toRealPath(): Path