commonMain.io.matthewnelson.kmp.process.AsyncWriteStream.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of process-jvm Show documentation

Process for Kotlin Multiplatform

There is a newer version: 0.1.2

/*
 * Copyright (c) 2024 Matthew Nelson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/
@file:Suppress("EXPECT_ACTUAL_CLASSIFIERS_ARE_IN_BETA_WARNING")

package io.matthewnelson.kmp.process

import io.matthewnelson.kmp.file.IOException
import kotlin.coroutines.cancellation.CancellationException

/**
 * A stream to write to. On Jvm & Native, blocking APIs are
 * available via [io.matthewnelson.kmp.process.BufferedWriteStream].
 *
 * On Jvm & Native, all Async functions utilize Dispatchers.IO
 * under the hood when calling BufferedWriteStream functions.
 *
 * **NOTE:** For Jvm & Android the `kotlinx.coroutines.core`
 * dependency is needed when using Async functions.
 * */
public expect class AsyncWriteStream {

    @Throws(
        CancellationException::class,
        IllegalArgumentException::class,
        IndexOutOfBoundsException::class,
        IOException::class,
    )
    public suspend fun writeAsync(buf: ByteArray, offset: Int, len: Int)

    @Throws(CancellationException::class, IOException::class)
    public suspend fun writeAsync(buf: ByteArray)

    @Throws(CancellationException::class, IOException::class)
    public suspend fun flushAsync()

    @Throws(CancellationException::class, IOException::class)
    public suspend fun closeAsync()

    @Throws(IOException::class)
    public fun flush()

    @Throws(IOException::class)
    public fun close()
}