Okio Documentation

Okio feature availability varies by platform:

To make tests faster and more reliable, swap FileSystem.SYSTEM with FakeFileSystem. This allows you to manipulate a virtual file system in memory without actual disk I/O. You can also use ForwardingFileSystem to inject faults (like simulating a full disk) to test error handling.

val fileSystem = FakeFileSystem()
val userHome = "/Users/sandy".toPath()
val gitConfig = userHome / ".gitconfig"

fileSystem.createDirectories(userHome)
val original = """
    |[user]
    |  email = sandy@example.com
    |".trimMargin()
fileSystem.write(gitConfig) { writeUtf8(original) }

// Example usage with a hypothetical fixer
GitConfigFixer(fileSystem).fix(userHome)

val expected = """
  |[user]
  |  email = sandy@example.com
|[diff]
  |  renames = true
  |  indentHeuristic = on
  |".trimIndent()
assertEquals(expected, fileSystem.read(gitConfig) { readUtf8() })

Use FileSystem.SYSTEM to perform concise reading and writing operations. Paths should be created using the .toPath() extension on a String. Reading and writing are performed within blocks that provide access to Okio buffers.

val path = "README.md".toPath()

val readmeContent = FileSystem.SYSTEM.read(path) {
  readUtf8()
}

val updatedContent = readmeContent.replace("red", "blue")

FileSystem.SYSTEM.write(path) {
  writeUtf8(updatedContent)
}

If you discover a security vulnerability in the Okio codebase, do not report it via public issues. Instead, follow the reporting guidelines provided by Square at Bugcrowd:

https://bugcrowd.com/squareopensource

To run the JMH microbenchmarks locally, use the Gradle wrapper from the project root. You can configure which benchmarks are selected and their settings in the jmh section of the okio/jvm/jmh/build.gradle file.

$ ./gradlew jmh

Use adb logcat with specific filters to monitor test execution and debug failures. The following command filters for relevant tags including TestRunner, TaskRunner, and error/fatal levels for specific components.

adb logcat '*:E' TestRunner:D TaskRunner:D GnssHAL_GnssInterface:F DeviceStateChecker:F memtrack:F