Package okio

Types

ArrayIndexOutOfBoundsException

class ArrayIndexOutOfBoundsException(message: String?) : IndexOutOfBoundsException

typealias ArrayIndexOutOfBoundsException = ArrayIndexOutOfBoundsException

AsyncTimeout

jvm

open class AsyncTimeout : Timeout

This timeout uses a background thread to take action exactly when the timeout occurs.

Buffer

common

class Buffer : BufferedSource, BufferedSink

A collection of bytes in memory.

jvm

class Buffer : BufferedSource, BufferedSink, Cloneable, ByteChannel

BufferedSink

common

interface BufferedSink : Sink

A sink that keeps a buffer internally so that callers can do small writes without a performance penalty.

jvm

interface BufferedSink : Sink, WritableByteChannel

BufferedSource

common

interface BufferedSource : Source

A source that keeps a buffer internally so that callers can do small reads without a performance penalty.

jvm

interface BufferedSource : Source, ReadableByteChannel

ByteString

common

open class ByteString : Comparable<ByteString>

An immutable sequence of bytes.

jvm

open class ByteString : Serializable, Comparable<ByteString>

CipherSink

jvm

class CipherSink(sink: BufferedSink, cipher: Cipher) : Sink

CipherSource

jvm

class CipherSource(source: BufferedSource, cipher: Cipher) : Source

Closeable

interface Closeable

typealias Closeable = Closeable

DeflaterSink

jvm

class DeflaterSink : Sink

A sink that uses DEFLATE to compress data written to another source.

EOFException

open class EOFException(message: String?) : IOException

typealias EOFException = EOFException

ExperimentalFileSystem

common

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalFileSystem

FileNotFoundException

class FileNotFoundException(message: String?) : IOException

typealias FileNotFoundException = FileNotFoundException

ForwardingSink

jvm

abstract class ForwardingSink(delegate: Sink) : Sink

A Sink which forwards calls to another.

ForwardingSource

jvm

abstract class ForwardingSource(delegate: Source) : Source

A Source which forwards calls to another.

ForwardingTimeout

jvm

open class ForwardingTimeout(delegate: Timeout) : Timeout

A Timeout which forwards calls to another.

GzipSink

jvm

class GzipSink(sink: Sink) : Sink

A sink that uses GZIP to compress written data to another sink.

GzipSource

jvm

class GzipSource(source: Source) : Source

A source that uses GZIP to decompress data read from another source.

HashingSink

common

class HashingSink : Sink

A sink that computes a hash of the full stream of bytes it has accepted.

jvm

class HashingSink : ForwardingSink, Sink

A sink that computes a hash of the full stream of bytes it has accepted.

HashingSource

common

class HashingSource : Source

A source that computes a hash of the full stream of bytes it has supplied.

jvm

class HashingSource : ForwardingSource, Source

A source that computes a hash of the full stream of bytes it has supplied.

InflaterSource

jvm

class InflaterSource : Source

A source that uses DEFLATE to decompress data read from another source.

IOException

open class IOException(message: String?, cause: Throwable?) : Exception

typealias IOException = IOException

Options

common

class Options : AbstractList<ByteString> , RandomAccess

An indexed set of values that may be read with BufferedSource.select.

Pipe

jvm

class Pipe(maxBufferSize: Long)

A source and a sink that are attached.

Sink

common

interface Sink : Closeable

Receives a stream of bytes.

jvm

interface Sink : Closeable, Flushable

Source

common

interface Source : Closeable

Supplies a stream of bytes.

Throttler

jvm

class Throttler

Enables limiting of Source and Sink throughput.

Timeout

common

open class Timeout

A policy on how much time to spend on a task before giving up.

jvm

open class Timeout

Functions

appendingSink

jvm

fun File.appendingSink(): Sink

Returns a sink that writes to file.

blackholeSink

common

@JvmName(name = "blackhole")

fun blackholeSink(): Sink

Returns a sink that writes nowhere.

buffer

common

fun Sink.buffer(): BufferedSink

Returns a new sink that buffers writes to sink.

fun Source.buffer(): BufferedSource

Returns a new source that buffers reads from source.

cipherSink

jvm

fun Sink.cipherSink(cipher: Cipher): CipherSink

Returns a sink that uses cipher to encrypt or decrypt this.

cipherSource

jvm

fun Source.cipherSource(cipher: Cipher): CipherSource

Returns a source that uses cipher to encrypt or decrypt this.

deflate

jvm

inline fun Sink.deflate(deflater: Deflater = Deflater()): DeflaterSink

Returns an DeflaterSink that DEFLATE-compresses data to this Sink while writing.

gzip

jvm

inline fun Sink.gzip(): GzipSink

Returns a GzipSink that gzip-compresses to this Sink while writing.

inline fun Source.gzip(): GzipSource

Returns a GzipSource that gzip-decompresses this Source while reading.

hashingSink

jvm

fun Sink.hashingSink(digest: MessageDigest): HashingSink

Returns a sink that uses digest to hash this.

fun Sink.hashingSink(mac: Mac): HashingSink

Returns a sink that uses mac to hash this.

hashingSource

jvm

fun Source.hashingSource(digest: MessageDigest): HashingSource

Returns a source that uses digest to hash this.

fun Source.hashingSource(mac: Mac): HashingSource

Returns a source that uses mac to hash this.

inflate

jvm

inline fun Source.inflate(inflater: Inflater = Inflater()): InflaterSource

Returns an InflaterSource that DEFLATE-decompresses this Source while reading.

sink

jvm

fun OutputStream.sink(): Sink

Returns a sink that writes to out.

fun Socket.sink(): Sink

Returns a sink that writes to socket.

@JvmOverloads()

fun File.sink(append: Boolean = false): Sink

Returns a sink that writes to file.

@IgnoreJRERequirement()

fun Path.sink(vararg options: OpenOption): Sink

Returns a source that reads from path.

source

jvm

fun File.source(): Source

Returns a source that reads from file.

fun InputStream.source(): Source

Returns a source that reads from in.

fun Socket.source(): Source

Returns a source that reads from socket.

@IgnoreJRERequirement()

fun Path.source(vararg options: OpenOption): Source

Returns a sink that writes to path.

toByteString

apple

fun <ERROR CLASS>.toByteString(): <ERROR CLASS>

use

common

inline fun <T : Closeable?, R> T.use(block: (T) -> R): R

Execute block then close this.

utf8Size

common

@JvmOverloads()

@JvmName(name = "size")

fun String.utf8Size(beginIndex: Int = 0, endIndex: Int = length): Long

Returns the number of bytes used to encode the slice of string as UTF-8 when using BufferedSink.writeUtf8.

Properties

Okio

jvm

val Okio: -DeprecatedOkio

Utf8

jvm

val Utf8: -DeprecatedUtf8