runtime-core/aws.smithy.kotlin.runtime.util/PlatformProvider

PlatformProvider

interface PlatformProvider : PlatformEnvironProvider, Filesystem

Inheritors

SystemDefaultProviderBase

Types

Companion

object Companion

Properties

isAndroid

abstract val isAndroid: Boolean

isBrowser

abstract val isBrowser: Boolean

isJvm

abstract val isJvm: Boolean

isNative

abstract val isNative: Boolean

isNode

abstract val isNode: Boolean

Inherited properties

filePathSeparator

abstract val filePathSeparator: String

The delimiter of segments in a path. For example in Linux: /home/user/documents or Windows: C:\Program Files\Notepad.EXE

Functions

osInfo

abstract fun osInfo(): OperatingSystem

Get the operating system info

Inherited functions

atomicMove

open fun atomicMove(source: String, destination: String, mustExist: Boolean = true, overwrite: Boolean = false)

Atomically move a file from source to destination.

createDir

open fun createDir(path: String, mustCreate: Boolean = false)

Create a directory (and any missing parent directories) at path.

delete

open fun delete(path: String, mustExist: Boolean = true)

Delete a file at path.

exists

open fun exists(path: String): Boolean

Check if a file or directory exists at path.

fileExists

abstract fun fileExists(path: String): Boolean

Check if a file exists at the path.

getAllEnvVars

abstract fun getAllEnvVars(): Map<String, String>

Get a map of all environment variables.

getAllProperties

abstract fun getAllProperties(): Map<String, String>

Get a map of all JVM system properties.

getenv

abstract fun getenv(key: String): String?

Get an environment variable or null

getProperty

abstract fun getProperty(key: String): String?

Get a system property (on supported platforms)

list

open fun list(path: String, mustExist: Boolean = true): Collection<String>

List the names of files and directories within the directory at path.

read

open fun read(path: String, amount: Long = 0, offset: Long = 0, readAll: Boolean = false): ByteArray

Read bytes from a file at path.

readFileOrNull

abstract suspend fun readFileOrNull(path: String): ByteArray?

Read the contents of a file as a String or return null on any error.

readOrNull

open fun readOrNull(path: String, amount: Long = 0, offset: Long = 0, readAll: Boolean = false, mustExist: Boolean = true): ByteArray?

Read bytes from a file at path, returning null if the file does not exist and mustExist is false.

size

open fun size(path: String, mustExist: Boolean = true): Long

Get the size of a file at path in bytes.

write

abstract fun write(path: String, data: ByteArray, writeType: WriteType, mustExist: Boolean = false, permissions: String? = null)

Write data to a file at path using the specified writeType strategy.

writeFile

abstract suspend fun writeFile(path: String, data: ByteArray)

Write the contents of a file. File will be created if it doesn't exist. Existing files will be overwritten.