Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Kotlin/kotlinx-io

Kotlin multiplatform I/O library
https://github.com/Kotlin/kotlinx-io

io kotlin kotlinx

Last synced: about 1 month ago
JSON representation

Kotlin multiplatform I/O library

Host: GitHub
URL: https://github.com/Kotlin/kotlinx-io
Owner: Kotlin
License: apache-2.0
Created: 2017-10-04T19:31:15.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-05-17T11:40:00.000Z (about 1 month ago)
Last Synced: 2024-05-17T12:32:23.174Z (about 1 month ago)
Topics: io, kotlin, kotlinx
Language: Kotlin
Homepage:
Size: 3.74 MB
Stars: 1,083
Watchers: 58
Forks: 55
Open Issues: 51
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-0.1.X.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Lists

Android-Guide - kotlinx-io
VSCode-Guide - Kotlinx-io
Developer-Handbook - kotlinx-io
awesome-kotlin-multiplatform - kotlinx-io
awesome-kotlin-multiplatform - Kotlin IO - Multiplatform library suitable for I/O primitives building and manipulations.|Java, Android, JS, iOS, macOS, Linux, Windows| (Libraries)

README

        # kotlinx-io

[![Kotlin Alpha](https://kotl.in/badges/alpha.svg)](https://kotlinlang.org/docs/components-stability.html)

[![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

[![GitHub license](https://img.shields.io/github/license/kotlin/kotlinx-io)](LICENSE)

[![Download](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/kotlinx-io-core)](https://central.sonatype.com/artifact/org.jetbrains.kotlinx/kotlinx-io-core/)

[![Kotlin](https://img.shields.io/badge/kotlin-1.9.24-blue.svg?logo=kotlin)](http://kotlinlang.org)

[![TeamCity build](https://img.shields.io/teamcity/build/s/KotlinTools_KotlinxIo_BuildAggregated.svg?server=http%3A%2F%2Fteamcity.jetbrains.com)](https://teamcity.jetbrains.com/viewType.html?buildTypeId=KotlinTools_KotlinxIo_BuildAggregated&guest=1)

[![KDoc link](https://img.shields.io/badge/API_reference-KDoc-blue)](https://kotlin.github.io/kotlinx-io/)

A multiplatform Kotlin library providing basic IO primitives. `kotlinx-io` is based on [Okio](https://github.com/square/okio) but does not preserve backward compatibility with it.

## Overview

**kotlinx-io** is built around `Buffer` - a mutable sequence of bytes.

`Buffer` works like a queue, allowing to read data from its head or to write data to its tail.

`Buffer` provides functions to read and write data of different built-in types, and to copy data to or from other `Buffer`s.

Depending on the target platform, extension functions allowing data exchange with platform-specific types are also available.

A `Buffer` consists of segments organized as a linked list: segments allow reducing memory allocations during the buffer's expansion and copy,

with the latter achieved by delegating or sharing the ownership over the underlying buffer's segments with other buffers.

**kotlinx-io** provides interfaces representing data sources and destinations - `Source` and `Sink`,

and in addition to the *mutable* `Buffer` the library also provides an *immutable* sequence of bytes - `ByteString`.

An experimental filesystem support is shipped under the `kotlinx.io.files` package,

which includes the `FileSystem` interface and its default implementation - `SystemFileSystem`.

`FileSystem` provides basic operations for working with files and directories, which are represented by yet another class under the same package - `Path`.

There are two `kotlinx-io` modules:

- [kotlinx-io-bytestring](./bytestring) - provides `ByteString`.

- [kotlinx-io-core](./core) - provides IO primitives (`Buffer`, `Source`, `Sink`), filesystems support, depends on `kotlinx-io-bytestring`.

## Using in your projects

> Note that the library is experimental, and the API is subject to change.

### Gradle

Make sure that you have `mavenCentral()` in the list of repositories:

```kotlin

repositories {

    mavenCentral()

}

```

Add the library to dependencies:

```kotlin

dependencies {

    implementation("org.jetbrains.kotlinx:kotlinx-io-core:0.3.5")

}

```

In multiplatform projects, add a dependency to the `commonMain` source set dependencies:

```kotlin

kotlin {

    sourceSets {

        commonMain {

            dependencies {

                implementation("org.jetbrains.kotlinx:kotlinx-io-core:0.3.5")

            }

        }

    }

}

```

### Maven

Add the library to dependencies:

```xml

    org.jetbrains.kotlinx

    kotlinx-io-core-jvm

    0.3.5

```

### Android

`kotlinx-io` is not tested on Android on a regular basis,

but the library is compatible with Android 5.0+ (API level 21+).

## Contributing

Read the [Contributing Guidelines](CONTRIBUTING.md).

## Code of Conduct

This project and the corresponding community are governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). Please make sure you read it.

## License

kotlinx-io is licensed under the [Apache 2.0 License](LICENSE).

## Credits

Thanks to everyone involved in the project.

An honorable mention goes to the developers of [Okio](https://square.github.io/okio/) 

that served as the foundation for `kotlinx-io` and to [Jesse Wilson](https://github.com/swankjesse),

for the help with `Okio` adaption, his suggestions, assistance and guidance with `kotlinx-io` development.