diff --git a/docs/index.html b/docs/index.html index 21a0101c..ca72efa4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -44,7 +44,7 @@
-0.5.3
+0.5.4 -
0.5.3 +
0.5.4
+
@@ -59,26 +60,27 @@
-
+

kotlinx-io-bytestring

-
-

The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.

The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.

+
+

The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.

The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.

The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.

Packages

-
-
+
+
- +
Link copied to clipboard
+
apple
common
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html index 0ca40322..1b1d3997 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html index 37b4313e..34fc2c0b 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html index 2520145a..da299bc5 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html index 2c2dc593..d35092e8 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html index c2784974..a1a56e7a 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html index 8f6690af..73757487 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html index 9b9bb48b..7f6278c8 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

ByteString

-
fun ByteString(vararg bytes: Byte): ByteString(source)

Wraps given bytes into a byte string.

Parameters

bytes

a sequence of bytes to be wrapped.

Samples

import kotlinx.io.bytestring.*
+  
fun ByteString(vararg bytes: Byte): ByteString(source)

Wraps given bytes into a byte string.

Parameters

bytes

a sequence of bytes to be wrapped.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -76,7 +76,16 @@ 

ByteString

assertFalse(byteStringFromBytes.isEmpty()) assertEquals(3, byteStringFromBytes.size) //sampleEnd -}
+}

fun ByteString(vararg bytes: UByte): ByteString(source)

Wraps given bytes into a byte string.

Internally, bytes will be stored as ByteArray, and accesses to individual ByteString's bytes will return a signed Byte as if someone call bytes[i].toByte().

Parameters

bytes

a sequence of bytes to be wrapped.

Samples

import kotlinx.io.bytestring.*
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val byteStringFromBytes = ByteString(0xCAu, 0xFEu)
+assertFalse(byteStringFromBytes.isEmpty())
+assertEquals(2, byteStringFromBytes.size) 
+   //sampleEnd
+}

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

ByteString

-
constructor(data: ByteArray, startIndex: Int = 0, endIndex: Int = data.size)(source)

Wraps a copy of data subarray starting at startIndex and ending at endIndex into a byte string.

Parameters

data

the array whose subarray should be copied and wrapped into a byte string.

startIndex

the start index (inclusive) of a subarray to copy, 0 by default.

endIndex

the end index (exclusive) of a subarray to copy, data.size be default.

Throws

when startIndex or endIndex is out of range of data array indices.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
+  
constructor(data: ByteArray, startIndex: Int = 0, endIndex: Int = data.size)(source)

Wraps a copy of data subarray starting at startIndex and ending at endIndex into a byte string.

Parameters

data

the array whose subarray should be copied and wrapped into a byte string.

startIndex

the start index (inclusive) of a subarray to copy, 0 by default.

endIndex

the end index (exclusive) of a subarray to copy, data.size be default.

Throws

when startIndex or endIndex is out of range of data array indices.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-companion/index.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-companion/index.html
index 769cf99f..897eb4e3 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-companion/index.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-companion/index.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -62,7 +62,7 @@

Companion

- +
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/compare-to.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/compare-to.html index 70593e15..a750addd 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/compare-to.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/compare-to.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

compareTo

-
open operator override fun compareTo(other: ByteString): Int(source)

Compares a byte sequence wrapped by this byte string to a byte sequence wrapped by other in lexicographical order. Byte values are compared as unsigned integers.

The behavior is similar to String.compareTo.

Parameters

other

the byte string to compare this string to.

Samples

import kotlinx.io.bytestring.*
+  
open operator override fun compareTo(other: ByteString): Int(source)

Compares a byte sequence wrapped by this byte string to a byte sequence wrapped by other in lexicographical order. Byte values are compared as unsigned integers.

The behavior is similar to String.compareTo.

Parameters

other

the byte string to compare this string to.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/copy-into.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/copy-into.html
index 4641ea39..16bb7c62 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/copy-into.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/copy-into.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

copyInto

-
fun copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size)(source)

Copies a subsequence starting at startIndex and ending at endIndex of a byte sequence wrapped by this byte string and writes it into destination array starting at destinationOffset offset.

Parameters

destination

the array to copy data into.

destinationOffset

the offset starting from which data copy should be written to destination.

startIndex

the start index (inclusive) of a subsequence to copy, 0 by default.

endIndex

the end index (exclusive) of a subsequence to copy, size be default.

Throws

when the subrange doesn't fit into the destination array starting at the specified destinationOffset, or when that index is out of the destination array indices range.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
+  
fun copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size)(source)

Copies a subsequence starting at startIndex and ending at endIndex of a byte sequence wrapped by this byte string and writes it into destination array starting at destinationOffset offset.

Parameters

destination

the array to copy data into.

destinationOffset

the offset starting from which data copy should be written to destination.

startIndex

the start index (inclusive) of a subsequence to copy, 0 by default.

endIndex

the end index (exclusive) of a subsequence to copy, size be default.

Throws

when the subrange doesn't fit into the destination array starting at the specified destinationOffset, or when that index is out of the destination array indices range.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/equals.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/equals.html
index 4c5e9a76..6d7e8091 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/equals.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/equals.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

equals

-
open operator override fun equals(other: Any?): Boolean(source)

Returns true if other is a byte string containing exactly the same byte sequence.

Parameters

other

the other object to compare this byte string for equality to.

+
open operator override fun equals(other: Any?): Boolean(source)

Returns true if other is a byte string containing exactly the same byte sequence.

Parameters

other

the other object to compare this byte string for equality to.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

get

-
operator fun get(index: Int): Byte(source)

Returns a byte at the given index in this byte string.

Parameters

index

the index to retrieve the byte at.

Throws

when index is negative or greater or equal to the size.

+
operator fun get(index: Int): Byte(source)

Returns a byte at the given index in this byte string.

Parameters

index

the index to retrieve the byte at.

Throws

when index is negative or greater or equal to the size.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

hashCode

-
open override fun hashCode(): Int(source)

Returns a hash code based on the content of this byte string.

+
open override fun hashCode(): Int(source)

Returns a hash code based on the content of this byte string.

-
0.5.3 +
0.5.4
+
@@ -63,7 +64,7 @@

ByteString

-

An immutable wrapper around a byte sequence providing String like functionality.

ByteString allows treating binary data as a value and passing it to other functions without worrying about data modification. The class facilitates various operations on binary data, like comparison or testing for subsequence inclusion.

ByteString is a good fit for untyped binary data that could not be represented as String, like hashes, payload of network packets, encrypted data, etc.

ByteString copies data on creation as well as on conversion back to ByteArray, thus guaranteeing that subsequent modification of source data or data returned from toByteArray won't mutate the string itself.

+

An immutable wrapper around a byte sequence providing String like functionality.

ByteString allows treating binary data as a value and passing it to other functions without worrying about data modification. The class facilitates various operations on binary data, like comparison or testing for subsequence inclusion.

ByteString is a good fit for untyped binary data that could not be represented as String, like hashes, payload of network packets, encrypted data, etc.

ByteString copies data on creation as well as on conversion back to ByteArray, thus guaranteeing that subsequent modification of source data or data returned from toByteArray won't mutate the string itself.

@@ -142,7 +143,24 @@

Properties

Functions

-
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+

Returns a new read-only heap ByteBuffer wrapping this ByteString's content.

+
+
+
+
+
@@ -384,6 +402,23 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+
fun ByteString.toNSData(): NSData

Returns a new NSData instance initialized with bytes copied from this ByteString.

+
+
+
+
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/size.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/size.html index ea229c12..d6165692 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/size.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/size.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

size

-

Returns size of this ByteString.

+

Returns size of this ByteString.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

substring

-
fun substring(startIndex: Int, endIndex: Int = size): ByteString(source)

Returns a new byte string wrapping a subsequence of bytes wrapped by this byte string starting from startIndex and ending at endIndex.

Parameters

startIndex

the start index (inclusive) of a subsequence to copy.

endIndex

the end index (exclusive) of a subsequence to copy, size be default.

Throws

when startIndex or endIndex is out of range of byte string indices.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
+  
fun substring(startIndex: Int, endIndex: Int = size): ByteString(source)

Returns a new byte string wrapping a subsequence of bytes wrapped by this byte string starting from startIndex and ending at endIndex.

Parameters

startIndex

the start index (inclusive) of a subsequence to copy.

endIndex

the end index (exclusive) of a subsequence to copy, size be default.

Throws

when startIndex or endIndex is out of range of byte string indices.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-byte-array.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-byte-array.html
index 346b20be..d57e56ab 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-byte-array.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-byte-array.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

toByteArray

-
fun toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray(source)

Returns a copy of subsequence starting at startIndex and ending at endIndex of a byte sequence wrapped by this byte string.

Parameters

startIndex

the start index (inclusive) of a subsequence to copy, 0 by default.

endIndex

the end index (exclusive) of a subsequence to copy, size be default.

Throws

when startIndex or endIndex is out of range of byte string indices.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
+  
fun toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray(source)

Returns a copy of subsequence starting at startIndex and ending at endIndex of a byte sequence wrapped by this byte string.

Parameters

startIndex

the start index (inclusive) of a subsequence to copy, 0 by default.

endIndex

the end index (exclusive) of a subsequence to copy, size be default.

Throws

when startIndex or endIndex is out of range of byte string indices.

when startIndex > endIndex.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-string.html
index 0076afb7..12d1863f 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-string.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-string.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

toString

-
open override fun toString(): String(source)

Returns a string representation of this byte string. A string representation consists of size and a hexadecimal-encoded string of a byte sequence wrapped by this byte string.

The string representation has the following format ByteString(size=3 hex=ABCDEF), for empty strings it's always ByteString(size=0).

Note that a string representation includes the whole byte string content encoded. Due to limitations exposed for the maximum string length, an attempt to return a string representation of too long byte string may fail.

Samples

import kotlinx.io.bytestring.*
+  
open override fun toString(): String(source)

Returns a string representation of this byte string. A string representation consists of size and a hexadecimal-encoded string of a byte sequence wrapped by this byte string.

The string representation has the following format ByteString(size=3 hex=ABCDEF), for empty strings it's always ByteString(size=0).

Note that a string representation includes the whole byte string content encoded. Due to limitations exposed for the maximum string length, an attempt to return a string representation of too long byte string may fail.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/append.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/append.html
index 73e38779..591ae09d 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/append.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/append.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/as-read-only-byte-buffer.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/as-read-only-byte-buffer.html new file mode 100644 index 00000000..ae8d5483 --- /dev/null +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/as-read-only-byte-buffer.html @@ -0,0 +1,94 @@ + + + + + asReadOnlyByteBuffer + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

asReadOnlyByteBuffer

+
+
+
+

Returns a new read-only heap ByteBuffer wrapping this ByteString's content.

Samples

import kotlinx.io.bytestring.*
+import java.nio.ByteBuffer
+import java.nio.ReadOnlyBufferException
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val str = "Hello World".encodeToByteString()
+val buffer = str.asReadOnlyByteBuffer()
+
+assertEquals(11, buffer.remaining())
+assertEquals(0x48656c6c, buffer.getInt())
+
+buffer.flip()
+assertFailsWith<ReadOnlyBufferException> { buffer.put(42) } 
+   //sampleEnd
+}
+
+ +
+
+
+ + + diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/build-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/build-byte-string.html index 774c8f9d..dbc1a119 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/build-byte-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/build-byte-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/content-equals.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/content-equals.html index de10a7b4..e7157ed0 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/content-equals.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/content-equals.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

contentEquals

-

Returns true if the content of this byte string equals to the array.

Parameters

array

the array to test this byte string's content against.

+

Returns true if the content of this byte string equals to the array.

Parameters

array

the array to test this byte string's content against.

-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html index 2ff3098d..b9d4b063 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html index 31d2154d..d171d61e 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -66,7 +66,7 @@

decodeToString

-

Decodes content of a byte string into a string using UTF-8 encoding.

Samples

import kotlinx.io.bytestring.*
+

Decodes content of a byte string into a string using UTF-8 encoding.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -83,7 +83,7 @@ 

decodeToString ) assertEquals("hello", helloAsByteString.decodeToString()) //sampleEnd -}

Decodes the content of a byte string to a string using given charset.

Parameters

charset

the charset to decode data into a string.

+}

Decodes the content of a byte string to a string using given charset.

Parameters

charset

the charset to decode data into a string.

-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-into-byte-array.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-into-byte-array.html index a5d49be7..0f23418b 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-into-byte-array.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-into-byte-array.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-appendable.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-appendable.html index ac27a918..f020aadf 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-appendable.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-appendable.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-array.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-array.html index 3a906478..cf7730ec 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-array.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-array.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html index 3a8ed917..e5a044e7 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -66,7 +66,7 @@

encodeToByte<

-

Encodes a string into a byte sequence using UTF8-encoding and wraps it into a byte string.

Samples

import kotlinx.io.bytestring.*
+

Encodes a string into a byte sequence using UTF8-encoding and wraps it into a byte string.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -83,7 +83,7 @@ 

encodeToByte< ) assertEquals("hello", helloAsByteString.decodeToString()) //sampleEnd -}

Encodes a string into a byte string using charset.

Parameters

charset

the encoding.

+}

Encodes a string into a byte string using charset.

Parameters

charset

the encoding.

-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html index 9004d277..483173dc 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

endsWith

-

Returns true if this byte string ends with the suffix specified by the byteArray.

Behavior of this method is compatible with CharSequence.endsWith.

Parameters

byteArray

the suffix to check for.

Samples

import kotlinx.io.bytestring.*
+  

Returns true if this byte string ends with the suffix specified by the byteArray.

Behavior of this method is compatible with CharSequence.endsWith.

Parameters

byteArray

the suffix to check for.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -76,7 +76,7 @@ 

endsWith

assertFalse(string.endsWith(byteArrayOf(2, 4, 5))) assertFalse(string.endsWith(byteArrayOf(0, 1, 2, 3, 4, 5))) //sampleEnd -}

Returns true if this byte string ends with the suffix specified by the byteString.

Behavior of this method is compatible with CharSequence.endsWith.

Parameters

byteString

the suffix to check for.

Samples

import kotlinx.io.bytestring.*
+}

Returns true if this byte string ends with the suffix specified by the byteString.

Behavior of this method is compatible with CharSequence.endsWith.

Parameters

byteString

the suffix to check for.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/get-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/get-byte-string.html
new file mode 100644
index 00000000..98fb6d33
--- /dev/null
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/get-byte-string.html
@@ -0,0 +1,112 @@
+
+
+
+    
+    getByteString
+    
+    
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+ +
+ +
+
+ +
+

getByteString

+
+
+
+
fun ByteBuffer.getByteString(length: Int = remaining()): ByteString(source)

Reads length bytes of data from this ByteBuffer starting from the current position and wraps them into a new ByteString.

Upon successful execution, current position will advance by length.

Throws

when length has negative value or its value exceeds ByteBuffer.remaining

Samples

import kotlinx.io.bytestring.*
+import java.nio.ByteBuffer
+import java.nio.ReadOnlyBufferException
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val buffer = ByteBuffer.wrap("Hello World".encodeToByteArray())
+
+// Consume the whole buffer
+val byteString = buffer.getByteString()
+assertEquals(0, buffer.remaining())
+assertEquals("Hello World".encodeToByteString(), byteString)
+
+// Reset the buffer
+buffer.flip()
+// Consume only first 5 bytes from the buffer
+assertEquals("Hello".encodeToByteString(), buffer.getByteString(length = 5)) 
+   //sampleEnd
+}

Reads length bytes of data from this ByteBuffer starting from at index and wraps them into a new ByteString.

This function does not update ByteBuffer.position.

Throws

when at is negative, greater or equal to ByteBuffer.limit or at + length exceeds ByteBuffer.limit.

Samples

import kotlinx.io.bytestring.*
+import java.nio.ByteBuffer
+import java.nio.ReadOnlyBufferException
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val buffer = ByteBuffer.wrap("Hello World".encodeToByteArray())
+
+// Read 2 bytes starting from offset 6
+val byteString = buffer.getByteString(at = 6, length = 2)
+// Buffer's position is not affected
+assertEquals(11, buffer.remaining())
+assertEquals(byteString, "Wo".encodeToByteString()) 
+   //sampleEnd
+}
+
+ +
+
+
+ + + diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/hex-to-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/hex-to-byte-string.html index 49556a78..8ffbdd45 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/hex-to-byte-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/hex-to-byte-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html index 672d7c26..fa8b9117 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

indexOf

-
fun ByteString.indexOf(byte: Byte, startIndex: Int = 0): Int(source)

Returns the index within this byte string of the first occurrence of the specified byte, starting from the specified startIndex. If the byte not found, -1 is returned.

Behavior of this method is compatible with CharSequence.indexOf.

Parameters

byte

the value to search for.

startIndex

the index (inclusive) starting from which the byte should be searched.

Samples

import kotlinx.io.bytestring.*
+  
fun ByteString.indexOf(byte: Byte, startIndex: Int = 0): Int(source)

Returns the index within this byte string of the first occurrence of the specified byte, starting from the specified startIndex. If the byte not found, -1 is returned.

Behavior of this method is compatible with CharSequence.indexOf.

Parameters

byte

the value to search for.

startIndex

the index (inclusive) starting from which the byte should be searched.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -74,7 +74,7 @@ 

indexOf

assertEquals(3, string.indexOf(2, startIndex = 2)) assertEquals(-1, string.indexOf(0)) //sampleEnd -}

fun ByteString.indexOf(byteString: ByteString, startIndex: Int = 0): Int(source)

Returns the index within this byte string of the first occurrence of the specified byteString, starting from the specified startIndex. If the byteString not found, -1 is returned.

Behavior of this method is compatible with CharSequence.indexOf.

Parameters

byteString

the value to search for.

startIndex

the index (inclusive) starting from which the byteString should be searched.

Samples

import kotlinx.io.bytestring.*
+}

fun ByteString.indexOf(byteString: ByteString, startIndex: Int = 0): Int(source)

Returns the index within this byte string of the first occurrence of the specified byteString, starting from the specified startIndex. If the byteString not found, -1 is returned.

Behavior of this method is compatible with CharSequence.indexOf.

Parameters

byteString

the value to search for.

startIndex

the index (inclusive) starting from which the byteString should be searched.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -87,7 +87,7 @@ 

indexOf

assertEquals(-1, string.indexOf(ByteString(1, 3, 4, 5))) assertEquals(0, string.indexOf(ByteString(/* empty byte string */))) //sampleEnd -}

fun ByteString.indexOf(byteArray: ByteArray, startIndex: Int = 0): Int(source)

Returns the index within this byte string of the first occurrence of the specified byteArray, starting from the specified startIndex. If the byteArray not found, -1 is returned.

Behavior of this method is compatible with CharSequence.indexOf.

Parameters

byteArray

the value to search for.

startIndex

the index (inclusive) starting from which the byteArray should be searched.

Samples

import kotlinx.io.bytestring.*
+}

fun ByteString.indexOf(byteArray: ByteArray, startIndex: Int = 0): Int(source)

Returns the index within this byte string of the first occurrence of the specified byteArray, starting from the specified startIndex. If the byteArray not found, -1 is returned.

Behavior of this method is compatible with CharSequence.indexOf.

Parameters

byteArray

the value to search for.

startIndex

the index (inclusive) starting from which the byteArray should be searched.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index.html
index 0ff872ff..3cf4d997 100644
--- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index.html
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/index.html
@@ -41,10 +41,11 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
+
@@ -59,7 +60,7 @@
-
+

Package-level declarations

@@ -137,6 +138,23 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+

Returns a new read-only heap ByteBuffer wrapping this ByteString's content.

+
+
+
+
@@ -152,17 +170,17 @@

Functions

- +
- +
Link copied to clipboard
-
fun ByteString(vararg bytes: Byte): ByteString

Wraps given bytes into a byte string.

+

fun ByteString(vararg bytes: Byte): ByteString
fun ByteString(vararg bytes: UByte): ByteString

Wraps given bytes into a byte string.

@@ -336,6 +354,23 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+
fun ByteBuffer.getByteString(length: Int = remaining()): ByteString

Reads length bytes of data from this ByteBuffer starting from the current position and wraps them into a new ByteString.

Reads length bytes of data from this ByteBuffer starting from at index and wraps them into a new ByteString.

+
+
+
+
@@ -411,6 +446,23 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+

Writes string into this ByteBuffer starting from the current position.

Writes string into this ByteBuffer starting from position at.

+
+
+
+
@@ -426,6 +478,23 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+
fun NSData.toByteString(): ByteString

Returns a new ByteString holding data copied from this NSData.

+
+
+
+
@@ -441,6 +510,23 @@

Functions

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
+
+
fun ByteString.toNSData(): NSData

Returns a new NSData instance initialized with bytes copied from this ByteString.

+
+
+
+
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/indices.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/indices.html index c8b1092b..9e783c3d 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/indices.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/indices.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

indices

-

Returns the range of valid byte indices for this byte string.

+

Returns the range of valid byte indices for this byte string.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

isEmpty

-

Returns true if this byte string is empty.

+

Returns true if this byte string is empty.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

isNotEmpty

-

Returns true if this byte string is not empty.

+

Returns true if this byte string is not empty.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

lastIndexOf

-
fun ByteString.lastIndexOf(byte: Byte, startIndex: Int = 0): Int(source)

Returns the index within this char sequence of the last occurrence of the specified byte, starting from the specified startIndex. If the byte not found, -1 is returned.

Behavior of this method is compatible with CharSequence.lastIndexOf.

Parameters

byte

the value to search for.

startIndex

the index (inclusive) starting from which the byte should be searched.

Samples

import kotlinx.io.bytestring.*
+  
fun ByteString.lastIndexOf(byte: Byte, startIndex: Int = 0): Int(source)

Returns the index within this char sequence of the last occurrence of the specified byte, starting from the specified startIndex. If the byte not found, -1 is returned.

Behavior of this method is compatible with CharSequence.lastIndexOf.

Parameters

byte

the value to search for.

startIndex

the index (inclusive) starting from which the byte should be searched.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -74,7 +74,7 @@ 

lastIndexOf


fun ByteString.lastIndexOf(byteString: ByteString, startIndex: Int = 0): Int(source)

Returns the index within this char sequence of the last occurrence of the specified byteString, starting from the specified startIndex. If the byteString not found, -1 is returned.

Behavior of this method is compatible with CharSequence.lastIndexOf.

Parameters

byteString

the value to search for.

startIndex

the index (inclusive) starting from which the byteString should be searched.

Samples

import kotlinx.io.bytestring.*
+}

fun ByteString.lastIndexOf(byteString: ByteString, startIndex: Int = 0): Int(source)

Returns the index within this char sequence of the last occurrence of the specified byteString, starting from the specified startIndex. If the byteString not found, -1 is returned.

Behavior of this method is compatible with CharSequence.lastIndexOf.

Parameters

byteString

the value to search for.

startIndex

the index (inclusive) starting from which the byteString should be searched.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -87,7 +87,7 @@ 

lastIndexOf


fun ByteString.lastIndexOf(byteArray: ByteArray, startIndex: Int = 0): Int(source)

Returns the index within this char sequence of the last occurrence of the specified byteArray, starting from the specified startIndex. If the byteArray not found, -1 is returned.

Behavior of this method is compatible with CharSequence.lastIndexOf.

Parameters

byteArray

the value to search for.

startIndex

the index (inclusive) starting from which the byteArray should be searched.

Samples

import kotlinx.io.bytestring.*
+}

fun ByteString.lastIndexOf(byteArray: ByteArray, startIndex: Int = 0): Int(source)

Returns the index within this char sequence of the last occurrence of the specified byteArray, starting from the specified startIndex. If the byteArray not found, -1 is returned.

Behavior of this method is compatible with CharSequence.lastIndexOf.

Parameters

byteArray

the value to search for.

startIndex

the index (inclusive) starting from which the byteArray should be searched.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/put-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/put-byte-string.html
new file mode 100644
index 00000000..e4901ea0
--- /dev/null
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/put-byte-string.html
@@ -0,0 +1,113 @@
+
+
+
+    
+    putByteString
+    
+    
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+ +
+ +
+
+ +
+

putByteString

+
+
+
+

Writes string into this ByteBuffer starting from the current position.

Upon successfully execution ByteBuffer.position will advance by the length of string.

Throws

when this buffer is read-only

when string can't fit into remaining space of this buffer

Samples

import kotlinx.io.bytestring.*
+import java.nio.ByteBuffer
+import java.nio.ReadOnlyBufferException
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val buffer = ByteBuffer.allocate(32)
+val byteString = ByteString(0x66, 0xdb.toByte(), 0x11, 0x50)
+
+// Putting a ByteString into a buffer will advance its position
+buffer.putByteString(byteString)
+assertEquals(4, buffer.position())
+
+buffer.flip()
+assertEquals(1725632848, buffer.getInt()) 
+   //sampleEnd
+}

Writes string into this ByteBuffer starting from position at.

This function does not update ByteBuffer.position.

Throws

when this buffer is read-only

Samples

import kotlinx.io.bytestring.*
+import java.nio.ByteBuffer
+import java.nio.ReadOnlyBufferException
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val buffer = ByteBuffer.allocate(8)
+val byteString = ByteString(0x78, 0x5e)
+
+// Putting a ByteString into a buffer using an absolute offset
+// won't change buffer's position.
+buffer.putByteString(at = 3, string = byteString)
+assertEquals(0, buffer.position())
+assertEquals(8, buffer.remaining())
+
+assertEquals(0x000000785e000000L, buffer.getLong()) 
+   //sampleEnd
+}
+
+ +
+
+
+ + + diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html index e93148b0..30effebb 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

startsWith

-

Returns true if this byte string starts with the prefix specified by the byteArray.

Behavior of this method is compatible with CharSequence.startsWith.

Parameters

byteArray

the prefix to check for.

Samples

import kotlinx.io.bytestring.*
+  

Returns true if this byte string starts with the prefix specified by the byteArray.

Behavior of this method is compatible with CharSequence.startsWith.

Parameters

byteArray

the prefix to check for.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
@@ -76,7 +76,7 @@ 

startsWith

assertFalse(string.startsWith(byteArrayOf(1, 3, 4))) assertFalse(string.startsWith(byteArrayOf(1, 2, 3, 4, 5, 6))) //sampleEnd -}

Returns true if this byte string starts with the prefix specified by the byteString.

Behavior of this method is compatible with CharSequence.startsWith.

Parameters

byteString

the prefix to check for.

Samples

import kotlinx.io.bytestring.*
+}

Returns true if this byte string starts with the prefix specified by the byteString.

Behavior of this method is compatible with CharSequence.startsWith.

Parameters

byteString

the prefix to check for.

Samples

import kotlinx.io.bytestring.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-byte-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-byte-string.html
new file mode 100644
index 00000000..11f44b9d
--- /dev/null
+++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-byte-string.html
@@ -0,0 +1,98 @@
+
+
+
+    
+    toByteString
+    
+    
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+ +
+ +
+
+ +
+

toByteString

+
+
+
+

Returns a new ByteString holding data copied from this NSData.

Samples

import kotlinx.cinterop.ExperimentalForeignApi
+import kotlinx.cinterop.UnsafeNumber
+import kotlinx.io.bytestring.*
+import platform.Foundation.*
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val originalByteString: ByteString = "Compress me, please!".encodeToByteString()
+
+val compressedNSData: NSData = originalByteString.toNSData().compressedDataUsingAlgorithm(
+    algorithm = NSDataCompressionAlgorithmZlib,
+    error = null
+)!!
+
+val compressedByteString: ByteString = compressedNSData.toByteString()
+assertEquals("73cecf2d284a2d2e56c84dd55128c8494d2c4e550400", compressedByteString.toHexString())
+// If there's no zlib-flate on your path, you can test it using:
+// zlib.decompress(binascii.unhexlify("73cecf2d284a2d2e56c84dd55128c8494d2c4e550400"), -15) 
+   //sampleEnd
+}
+
+ +
+
+
+ + + diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html index 1c14dc02..e4c2be44 100644 --- a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-n-s-data.html b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-n-s-data.html new file mode 100644 index 00000000..eaac2c98 --- /dev/null +++ b/docs/kotlinx-io-bytestring/kotlinx.io.bytestring/to-n-s-data.html @@ -0,0 +1,98 @@ + + + + + toNSData + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

toNSData

+
+
+
+
fun ByteString.toNSData(): NSData(source)

Returns a new NSData instance initialized with bytes copied from this ByteString.

Samples

import kotlinx.cinterop.ExperimentalForeignApi
+import kotlinx.cinterop.UnsafeNumber
+import kotlinx.io.bytestring.*
+import platform.Foundation.*
+import kotlin.test.*
+
+fun main() { 
+   //sampleStart 
+   val originalByteString: ByteString = "Compress me, please!".encodeToByteString()
+
+val compressedNSData: NSData = originalByteString.toNSData().compressedDataUsingAlgorithm(
+    algorithm = NSDataCompressionAlgorithmZlib,
+    error = null
+)!!
+
+val compressedByteString: ByteString = compressedNSData.toByteString()
+assertEquals("73cecf2d284a2d2e56c84dd55128c8494d2c4e550400", compressedByteString.toHexString())
+// If there's no zlib-flate on your path, you can test it using:
+// zlib.decompress(binascii.unhexlify("73cecf2d284a2d2e56c84dd55128c8494d2c4e550400"), -15) 
+   //sampleEnd
+}
+
+ +
+
+
+ + + diff --git a/docs/kotlinx-io-bytestring/navigation.html b/docs/kotlinx-io-bytestring/navigation.html index ccb42c9d..5ad33a39 100644 --- a/docs/kotlinx-io-bytestring/navigation.html +++ b/docs/kotlinx-io-bytestring/navigation.html @@ -1,9 +1,9 @@
-
+
-
+
@@ -12,126 +12,151 @@ append()
-
+ + -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
+ +
+ -
+ -
+ -
+ -
+ -
+ -
diff --git a/docs/kotlinx-io-core/index.html b/docs/kotlinx-io-core/index.html index 5793a5f9..e77dd45c 100644 --- a/docs/kotlinx-io-core/index.html +++ b/docs/kotlinx-io-core/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/-file-metadata.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/-file-metadata.html index f276d238..3ff90845 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/-file-metadata.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/-file-metadata.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/index.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/index.html index 3c80b073..86e9eaf7 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/index.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-directory.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-directory.html index a1f0b289..f942e559 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-directory.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-directory.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-regular-file.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-regular-file.html index 0dc4b545..64c78da8 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-regular-file.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/is-regular-file.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/size.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/size.html index 55438e70..e22a1eb1 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/size.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-metadata/size.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/-file-not-found-exception.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/-file-not-found-exception.html index ac091eb6..5bb9992d 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/-file-not-found-exception.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/-file-not-found-exception.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/index.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/index.html index 342b80de..ee882b55 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/index.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/atomic-move.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/atomic-move.html index 154c991a..20983c11 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/atomic-move.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/atomic-move.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/create-directories.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/create-directories.html index 036e9bc5..bd5c31ed 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/create-directories.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/create-directories.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/delete.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/delete.html index 8e7c8b6d..54e9d207 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/delete.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/delete.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/exists.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/exists.html index f8b5d91b..4020a933 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/exists.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/exists.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/index.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/index.html index 7f3d409a..ac951abc 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/index.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/list.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/list.html index 76ec80bf..39d0808c 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/list.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/list.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/metadata-or-null.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/metadata-or-null.html index 278272ec..94b13dc7 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/metadata-or-null.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/metadata-or-null.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/resolve.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/resolve.html index f8ee3803..e930b972 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/resolve.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/resolve.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/sink.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/sink.html index a7cb9443..f5f4c2f5 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/sink.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/sink.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/source.html b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/source.html index 61cce3e7..f0f00ed1 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-file-system/source.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-file-system/source.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-path.html b/docs/kotlinx-io-core/kotlinx.io.files/-path.html index a0e61a8d..5cb090e9 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-path.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-path.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

Path

-
fun Path(base: String, vararg parts: String): Path(source)
fun Path(base: Path, vararg parts: String): Path(source)

Returns Path for the given base path concatenated with parts using SystemPathSeparator.


expect fun Path(path: String): Path(source)

Returns Path for the given string without much of a validation.

actual fun Path(path: String): Path(source)
actual fun Path(path: String): Path(source)
actual fun Path(path: String): Path(source)
actual fun Path(path: String): Path(source)
+
fun Path(base: String, vararg parts: String): Path(source)
fun Path(base: Path, vararg parts: String): Path(source)

Returns Path for the given base path concatenated with parts using SystemPathSeparator.


expect fun Path(path: String): Path(source)

Returns Path for the given string without much of a validation.

actual fun Path(path: String): Path(source)
actual fun Path(path: String): Path(source)
actual fun Path(path: String): Path(source)
actual fun Path(path: String): Path(source)
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

equals

-
expect open operator override fun equals(other: Any?): Boolean(source)

Compares two paths for equality using its string representation (toString).

actual open operator override fun equals(other: Any?): Boolean(source)
actual open operator override fun equals(other: Any?): Boolean(source)
actual open operator override fun equals(other: Any?): Boolean(source)
actual open operator override fun equals(other: Any?): Boolean(source)
+
expect open operator override fun equals(other: Any?): Boolean(source)

Compares two paths for equality using its string representation (toString).

actual open operator override fun equals(other: Any?): Boolean(source)
actual open operator override fun equals(other: Any?): Boolean(source)
actual open operator override fun equals(other: Any?): Boolean(source)
actual open operator override fun equals(other: Any?): Boolean(source)
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

hashCode

-
expect open override fun hashCode(): Int(source)

Returns hash code of this Path. The hash code is calculated for the path's string representations (toString).

actual open override fun hashCode(): Int(source)
actual open override fun hashCode(): Int(source)
actual open override fun hashCode(): Int(source)
actual open override fun hashCode(): Int(source)
+
expect open override fun hashCode(): Int(source)

Returns hash code of this Path. The hash code is calculated for the path's string representations (toString).

actual open override fun hashCode(): Int(source)
actual open override fun hashCode(): Int(source)
actual open override fun hashCode(): Int(source)
actual open override fun hashCode(): Int(source)
-
0.5.3 +
0.5.4
@@ -68,7 +68,7 @@

Path

-
expect class Path(source)

A wrapper around a string representing a file path allowing to read from and write to a corresponding file using Sink and Source.

This API is unstable and subject to change.

actual class Path(source)
actual class Path(source)
actual class Path(source)
actual class Path(source)
+
expect class Path(source)

A wrapper around a string representing a file path allowing to read from and write to a corresponding file using Sink and Source.

This API is unstable and subject to change.

actual class Path(source)
actual class Path(source)
actual class Path(source)
actual class Path(source)
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-path/is-absolute.html b/docs/kotlinx-io-core/kotlinx.io.files/-path/is-absolute.html index 7b680e86..53db2cd7 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-path/is-absolute.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-path/is-absolute.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

isAbsolute

-

Returns true if this path is absolute, false otherwise.

How an absolute path is resolved is platform-specific.

+

Returns true if this path is absolute, false otherwise.

How an absolute path is resolved is platform-specific.

-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

name

-
expect val name: String(source)

Returns the name of the file or directory represented by this path.

How the name is resolved is platform-specific.

In general, one may expect that for a path like Path("home", "Downloads", "file.txt") the name is file.txt.

actual val name: String(source)
actual val name: String(source)
actual val name: String(source)
actual val name: String(source)
+
expect val name: String(source)

Returns the name of the file or directory represented by this path.

How the name is resolved is platform-specific.

In general, one may expect that for a path like Path("home", "Downloads", "file.txt") the name is file.txt.

actual val name: String(source)
actual val name: String(source)
actual val name: String(source)
actual val name: String(source)
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

parent

-
expect val parent: Path?(source)

Returns a path representing a parent directory for this path, or null if there is no parent directory for this path.

How the parent path is resolved is platform-specific.

actual val parent: Path?(source)
actual val parent: Path?(source)
actual val parent: Path?(source)
actual val parent: Path?(source)
+
expect val parent: Path?(source)

Returns a path representing a parent directory for this path, or null if there is no parent directory for this path.

How the parent path is resolved is platform-specific.

actual val parent: Path?(source)
actual val parent: Path?(source)
actual val parent: Path?(source)
actual val parent: Path?(source)
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

toString

-
expect open override fun toString(): String(source)

Returns a string representation of this path.

Note that the returned value will represent the same path as the value passed to Path, but it may not be identical to it.

actual open override fun toString(): String(source)
actual open override fun toString(): String(source)
actual open override fun toString(): String(source)
actual open override fun toString(): String(source)
+
expect open override fun toString(): String(source)

Returns a string representation of this path.

Note that the returned value will represent the same path as the value passed to Path, but it may not be identical to it.

actual open override fun toString(): String(source)
actual open override fun toString(): String(source)
actual open override fun toString(): String(source)
actual open override fun toString(): String(source)
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/-system-path-separator.html b/docs/kotlinx-io-core/kotlinx.io.files/-system-path-separator.html index 14503e76..f71d1658 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/-system-path-separator.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/-system-path-separator.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

SystemPathSepa

-

A platform-specific character separating parts of the path. It's inherited from the default system's filesystem. It should not be used if an application is working with multiple filesystems having different separators.

For example, the separator is usually / on Unix and \ on Windows.

+

A platform-specific character separating parts of the path. It's inherited from the default system's filesystem. It should not be used if an application is working with multiple filesystems having different separators.

For example, the separator is usually / on Unix and \ on Windows.

-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/index.html b/docs/kotlinx-io-core/kotlinx.io.files/index.html index 8af1b567..b6f2d18d 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/index.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/sink.html b/docs/kotlinx-io-core/kotlinx.io.files/sink.html index 228963cb..aba26a8d 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/sink.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/sink.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io.files/source.html b/docs/kotlinx-io-core/kotlinx.io.files/source.html index ea08033c..1177c771 100644 --- a/docs/kotlinx-io-core/kotlinx.io.files/source.html +++ b/docs/kotlinx-io-core/kotlinx.io.files/source.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/-buffer.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/-buffer.html index f5612783..8220184b 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-buffer/-buffer.html +++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/-buffer.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

Buffer

-
constructor()(source)
+
constructor()(source)
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

buffer

-
open override val buffer: Buffer(source)

Returns the buffer itself.

+
open override val buffer: Buffer(source)

Returns the buffer itself.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

clear

-
fun clear()(source)

Discards all bytes in this buffer.

Call to this method is equivalent to skip with byteCount = size.

Samples

import kotlinx.io.*
+  
fun clear()(source)

Discards all bytes in this buffer.

Call to this method is equivalent to skip with byteCount = size.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/close.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/close.html
index 2730358e..c5bceea5 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/close.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/close.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

close

-
open override fun close()(source)

This method does not affect the buffer.

+
open override fun close()(source)

This method does not affect the buffer.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

copyTo

-
fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)(source)

Copy bytes from this buffer's subrange starting at startIndex and ending at endIndex, to out buffer. This method does not consume data from the buffer.

Parameters

out

the destination buffer to copy data into.

startIndex

the index (inclusive) of the first byte of data in this buffer to copy, 0 by default.

endIndex

the index (exclusive) of the last byte of data in this buffer to copy, buffer.size by default.

Throws

when startIndex or endIndex is out of this buffer bounds ([0..buffer.size)).

when startIndex > endIndex.

Samples

import kotlinx.io.*
+  
fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)(source)

Copies bytes from this buffer's subrange starting at startIndex and ending at endIndex, to out buffer. This method does not consume data from the buffer.

Parameters

out

the destination buffer to copy data into.

startIndex

the index (inclusive) of the first byte of data in this buffer to copy, 0 by default.

endIndex

the index (exclusive) of the last byte of data in this buffer to copy, buffer.size by default.

Throws

when startIndex or endIndex is out of this buffer bounds ([0..buffer.size)).

when startIndex > endIndex.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/copy.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/copy.html
index 9d205d38..57d2d76b 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/copy.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/copy.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

copy

-

Returns a deep copy of this buffer.

+

Returns a deep copy of this buffer.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

emit

-
open override fun emit()(source)

This method does not affect the buffer's content as there is no upstream to write data to.

+
open override fun emit()(source)

This method does not affect the buffer's content as there is no upstream to write data to.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

exhausted

-
open override fun exhausted(): Boolean(source)

Returns true if there are no more bytes in this source.

The call of this method will block until there are bytes to read or the source is definitely exhausted.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun exhausted(): Boolean(source)

Returns true if there are no more bytes in this source.

The call of this method will block until there are bytes to read or the source is definitely exhausted.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/flush.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/flush.html
index 83f31af6..18265edd 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/flush.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/flush.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

flush

-
open override fun flush()(source)

This method does not affect the buffer's content as there is no upstream to write data to.

+
open override fun flush()(source)

This method does not affect the buffer's content as there is no upstream to write data to.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

get

-
operator fun get(position: Long): Byte(source)

Returns the byte at position.

Use of this method may expose significant performance penalties and it's not recommended to use it for sequential access to a range of bytes within the buffer.

Throws

when position is negative or greater or equal to Buffer.size.

Samples

import kotlinx.io.*
+  
operator fun get(position: Long): Byte(source)

Returns the byte at position.

Use of this method may expose significant performance penalties and it's not recommended to use it for sequential access to a range of bytes within the buffer.

Throws

when position is negative or greater or equal to Buffer.size.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/hint-emit.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/hint-emit.html
index 840677e6..e7274112 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/hint-emit.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/hint-emit.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

hintEmit

-
open override fun hintEmit()(source)

This method does not affect the buffer's content as there is no upstream to write data to.

+
open override fun hintEmit()(source)

This method does not affect the buffer's content as there is no upstream to write data to.

-
0.5.3 +
0.5.4
@@ -64,7 +64,7 @@

Buffer

-

A collection of bytes in memory.

The buffer can be viewed as an unbound queue whose size grows with the data being written and shrinks with data being consumed. Internally, the buffer consists of data segments, and the buffer's capacity grows and shrinks in units of data segments instead of individual bytes.

The buffer was designed to reduce memory allocations when possible. Instead of copying bytes from one place in memory to another, this class just changes ownership of the underlying data segments.

To reduce allocations and speed up the buffer's extension, it may use data segments pooling.

Buffer implements both Source and Sink and could be used as a source or a sink, but unlike regular sinks and sources its close, flush, emit, hintEmit does not affect buffer's state and exhausted only indicates that a buffer is empty.

+

A collection of bytes in memory.

The buffer can be viewed as an unbound queue whose size grows with the data being written and shrinks with data being consumed. Internally, the buffer consists of data segments, and the buffer's capacity grows and shrinks in units of data segments instead of individual bytes.

The buffer was designed to reduce memory allocations when possible. Instead of copying bytes from one place in memory to another, this class just changes ownership of the underlying data segments.

To reduce allocations and speed up the buffer's extension, it may use data segments pooling.

Buffer implements both Source and Sink and could be used as a source or a sink, but unlike regular sinks and sources its close, flush, emit, hintEmit does not affect buffer's state and exhausted only indicates that a buffer is empty.

@@ -279,7 +279,7 @@

Functions

-
fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)

Copy bytes from this buffer's subrange starting at startIndex and ending at endIndex, to out buffer. This method does not consume data from the buffer.

+
fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)

Copies bytes from this buffer's subrange starting at startIndex and ending at endIndex, to out buffer. This method does not consume data from the buffer.

@@ -296,7 +296,7 @@

Functions

-
fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)

Copy bytes from this buffer's subrange, starting at startIndex and ending at endIndex, to out. This method does not consume data from the buffer.

+
fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)

Copies bytes from this buffer's subrange, starting at startIndex and ending at endIndex, to out. This method does not consume data from the buffer.

@@ -979,7 +979,7 @@

Functions

-

Read and exhaust bytes from input into this buffer. Stops reading data on input exhaustion.

Reads all data from source into this buffer.

+

Reads and exhausts bytes from input into this buffer. Stops reading data on input exhaustion.

Reads all data from source into this buffer.

@@ -1026,7 +1026,7 @@

Functions

-
fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)

Writes subsequence of data from byteString starting at startIndex and ending at endIndex into a sink.

fun Sink.write(source: ByteBuffer): Int

Writes data from the source into this sink and returns the number of bytes written.

fun Buffer.write(input: InputStream, byteCount: Long): Buffer

Read byteCount bytes from input into this buffer. Throws an exception when input is exhausted before reading byteCount bytes.

+
fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)

Writes subsequence of data from byteString starting at startIndex and ending at endIndex into a sink.

fun Sink.write(source: ByteBuffer): Int

Writes data from the source into this sink and returns the number of bytes written.

fun Buffer.write(input: InputStream, byteCount: Long): Buffer

Reads byteCount bytes from input into this buffer. Throws an exception when input is exhausted before reading byteCount bytes.

diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/peek.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/peek.html index 9ee3ed57..19c8538b 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-buffer/peek.html +++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/peek.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

peek

-
open override fun peek(): Source(source)

Returns a new Source that can read data from this source without consuming it. The returned source becomes invalid once this source is next read or closed.

Peek could be used to lookahead and read the same data multiple times.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun peek(): Source(source)

Returns a new Source that can read data from this source without consuming it. The returned source becomes invalid once this source is next read or closed.

Peek could be used to lookahead and read the same data multiple times.

Throws

when the source is closed.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html
index 2450a590..65fe3986 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readAtMostTo

-
open override fun readAtMostTo(sink: ByteArray, startIndex: Int, endIndex: Int): Int(source)

Removes up to endIndex - startIndex bytes from this source, copies them into sink subrange starting at startIndex and ending at endIndex, and returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the array to which data will be written from this source.

startIndex

the startIndex (inclusive) of the sink subrange to read data into, 0 by default.

endIndex

the endIndex (exclusive) of the sink subrange to read data into, sink.size by default.

Throws

when startIndex or endIndex is out of range of sink array indices.

when startIndex > endIndex.

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun readAtMostTo(sink: ByteArray, startIndex: Int, endIndex: Int): Int(source)

Removes up to endIndex - startIndex bytes from this source, copies them into sink subrange starting at startIndex and ending at endIndex, and returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the array to which data will be written from this source.

startIndex

the startIndex (inclusive) of the sink subrange to read data into, 0 by default.

endIndex

the endIndex (exclusive) of the sink subrange to read data into, sink.size by default.

Throws

when startIndex or endIndex is out of range of sink array indices.

when startIndex > endIndex.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -75,7 +75,7 @@ 

readAtMost


open override fun readAtMostTo(sink: Buffer, byteCount: Long): Long(source)

Removes at least 1, and up to byteCount bytes from this source and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the destination to write the data from this source.

byteCount

the number of bytes to read.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+}

open override fun readAtMostTo(sink: Buffer, byteCount: Long): Long(source)

Removes at least 1, and up to byteCount bytes from this source and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the destination to write the data from this source.

byteCount

the number of bytes to read.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-byte.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-byte.html
index e6b9fe47..ab68ab8a 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-byte.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-byte.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readByte

-
open override fun readByte(): Byte(source)

Removes a byte from this source and returns it.

Throws

when there are no more bytes to read.

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun readByte(): Byte(source)

Removes a byte from this source and returns it.

Throws

when there are no more bytes to read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-int.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-int.html
index 5b7b28a7..8cd796a5 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-int.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-int.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readInt

-
open override fun readInt(): Int(source)

Removes four bytes from this source and returns an integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an int value.

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun readInt(): Int(source)

Removes four bytes from this source and returns an integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-long.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-long.html
index 96509563..ceda9dfe 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readLong

-
open override fun readLong(): Long(source)

Removes eight bytes from this source and returns a long integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a long value.

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun readLong(): Long(source)

Removes eight bytes from this source and returns a long integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a long value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-short.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-short.html
index 3d4ab361..7722e869 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-short.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-short.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readShort

-
open override fun readShort(): Short(source)

Removes two bytes from this source and returns a short integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a short value.

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun readShort(): Short(source)

Removes two bytes from this source and returns a short integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a short value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-to.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-to.html
index 6b21f4ce..24c836db 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/read-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/read-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readTo

-
open override fun readTo(sink: RawSink, byteCount: Long)(source)

Removes exactly byteCount bytes from this source and writes them to sink.

Parameters

sink

the sink to which data will be written from this source.

byteCount

the number of bytes that should be written into sink

Throws

when the requested number of bytes cannot be read.

when the source or sink is closed.

Samples

import kotlinx.io.*
+  
open override fun readTo(sink: RawSink, byteCount: Long)(source)

Removes exactly byteCount bytes from this source and writes them to sink.

Parameters

sink

the sink to which data will be written from this source.

byteCount

the number of bytes that should be written into sink

Throws

when the requested number of bytes cannot be read.

when the source or sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/request.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/request.html
index 0cc43c5f..d1674f80 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/request.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/request.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

request

-
open override fun request(byteCount: Long): Boolean(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and returns a value indicating if the requirement was successfully fulfilled.

false value returned by this method indicates that the underlying source was exhausted before filling the buffer with byteCount bytes of data.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun request(byteCount: Long): Boolean(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and returns a value indicating if the requirement was successfully fulfilled.

false value returned by this method indicates that the underlying source was exhausted before filling the buffer with byteCount bytes of data.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/require.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/require.html
index 9cd4a1f4..8f02ad78 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/require.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/require.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

require

-
open override fun require(byteCount: Long)(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and throw EOFException when the source is exhausted before fulfilling the requirement.

If the buffer already contains required number of bytes then there will be no requests to the underlying source.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is exhausted before the required bytes count could be read.

when the source is closed.

Samples

import kotlinx.io.*
+  
open override fun require(byteCount: Long)(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and throw EOFException when the source is exhausted before fulfilling the requirement.

If the buffer already contains required number of bytes then there will be no requests to the underlying source.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is exhausted before the required bytes count could be read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/size.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/size.html
index d972aebc..4cc439f2 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/size.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/size.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

size

-

The number of bytes accessible for read from this buffer.

+

The number of bytes accessible for read from this buffer.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

skip

-
open override fun skip(byteCount: Long)(source)

Discards byteCount bytes from the head of this buffer.

Throws

+
open override fun skip(byteCount: Long)(source)

Discards byteCount bytes from the head of this buffer.

Throws

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

toString

-
open override fun toString(): String(source)

Returns a human-readable string that describes the contents of this buffer. For buffers containing few bytes, this is a string like Buffer(size=4 hex=0000ffff). However, if the buffer is too large, a string will contain its size and only a prefix of data, like Buffer(size=1024 hex=01234…). Thus, the string could not be used to compare buffers or verify buffer's content.

Samples

import kotlinx.io.*
+  
open override fun toString(): String(source)

Returns a human-readable string that describes the contents of this buffer. For buffers containing few bytes, this is a string like Buffer(size=4 hex=0000ffff). However, if the buffer is too large, a string will contain its size and only a prefix of data, like Buffer(size=1024 hex=01234…). Thus, the string could not be used to compare buffers or verify buffer's content.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-from.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-from.html
index 752f85a8..7deef112 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-from.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-from.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

transferFrom

-
open override fun transferFrom(source: RawSource): Long(source)

Removes all bytes from source and write them to this sink. Returns the number of bytes read which will be 0 if source is exhausted.

Parameters

source

the source to consume data from.

Throws

when the sink or source is closed.

Samples

import kotlinx.io.*
+  
open override fun transferFrom(source: RawSource): Long(source)

Removes all bytes from source and write them to this sink. Returns the number of bytes read which will be 0 if source is exhausted.

Parameters

source

the source to consume data from.

Throws

when the sink or source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-to.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-to.html
index bc46768d..01214dfc 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/transfer-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

transferTo

-
open override fun transferTo(sink: RawSink): Long(source)

Removes all bytes from this source, writes them to sink, and returns the total number of bytes written to sink.

Return 0 if this source is exhausted.

Parameters

sink

the sink to which data will be written from this source.

Throws

when the source or sink is closed.

Samples

import kotlinx.io.*
+  
open override fun transferTo(sink: RawSink): Long(source)

Removes all bytes from this source, writes them to sink, and returns the total number of bytes written to sink.

Return 0 if this source is exhausted.

Parameters

sink

the sink to which data will be written from this source.

Throws

when the source or sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-byte.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-byte.html
index 06906ecf..c4e498d2 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-byte.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-byte.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeByte

-
open override fun writeByte(byte: Byte)(source)

Writes a byte to this sink.

Parameters

byte

the byte to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
open override fun writeByte(byte: Byte)(source)

Writes a byte to this sink.

Parameters

byte

the byte to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-int.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-int.html
index cb970c76..17d5593d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-int.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-int.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeInt

-
open override fun writeInt(int: Int)(source)

Writes four bytes containing int, in the big-endian order, to this sink.

Parameters

int

the integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
open override fun writeInt(int: Int)(source)

Writes four bytes containing int, in the big-endian order, to this sink.

Parameters

int

the integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-long.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-long.html
index 37cf27f1..393710fe 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeLong

-
open override fun writeLong(long: Long)(source)

Writes eight bytes containing long, in the big-endian order, to this sink.

Parameters

long

the long integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
open override fun writeLong(long: Long)(source)

Writes eight bytes containing long, in the big-endian order, to this sink.

Parameters

long

the long integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-short.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-short.html
index 0cae9af2..e9668da4 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/write-short.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/write-short.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeShort

-
open override fun writeShort(short: Short)(source)

Writes two bytes containing short, in the big-endian order, to this sink.

Parameters

short

the short integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
open override fun writeShort(short: Short)(source)

Writes two bytes containing short, in the big-endian order, to this sink.

Parameters

short

the short integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-buffer/write.html b/docs/kotlinx-io-core/kotlinx.io/-buffer/write.html
index 14fbce7a..1c9f5838 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-buffer/write.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-buffer/write.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

write

-
open override fun write(source: ByteArray, startIndex: Int, endIndex: Int)(source)

Writes bytes from source array or its subrange to this sink.

Parameters

source

the array from which bytes will be written into this sink.

startIndex

the start index (inclusive) of the source subrange to be written, 0 by default.

endIndex

the endIndex (exclusive) of the source subrange to be written, size of the source by default.

Throws

when startIndex or endIndex is out of range of source array indices.

when startIndex > endIndex.

when the sink is closed.

Samples

import kotlinx.io.*
+  
open override fun write(source: ByteArray, startIndex: Int, endIndex: Int)(source)

Writes bytes from source array or its subrange to this sink.

Parameters

source

the array from which bytes will be written into this sink.

startIndex

the start index (inclusive) of the source subrange to be written, 0 by default.

endIndex

the endIndex (exclusive) of the source subrange to be written, size of the source by default.

Throws

when startIndex or endIndex is out of range of source array indices.

when startIndex > endIndex.

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -76,7 +76,7 @@ 

write

sink.write(byteArrayOf(1, 2, 3, 4), startIndex = 1, endIndex = 3) assertContentEquals(byteArrayOf(2, 3), sink.readByteArray()) //sampleEnd -}

open override fun write(source: RawSource, byteCount: Long)(source)

Removes byteCount bytes from source and write them to this sink.

If source will be exhausted before reading byteCount from it then an exception throws on an attempt to read remaining bytes will be propagated to a caller of this method.

Parameters

source

the source to consume data from.

byteCount

the number of bytes to read from source and to write into this sink.

Throws

when the sink or source is closed.

Samples

import kotlinx.io.*
+}

open override fun write(source: RawSource, byteCount: Long)(source)

Removes byteCount bytes from source and write them to this sink.

If source will be exhausted before reading byteCount from it then an exception throws on an attempt to read remaining bytes will be propagated to a caller of this method.

Parameters

source

the source to consume data from.

byteCount

the number of bytes to read from source and to write into this sink.

Throws

when the sink or source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -88,7 +88,7 @@ 

write

assertContentEquals(byteArrayOf(1, 2, 3), sink.readByteArray()) assertContentEquals(byteArrayOf(4), source.readByteArray()) //sampleEnd -}

open override fun write(source: Buffer, byteCount: Long)(source)

Removes byteCount bytes from source and appends them to this sink.

Parameters

source

the source to read data from.

byteCount

the number of bytes to write.

Throws

when the source's size is below byteCount or byteCount is negative.

when the sink is closed.

+}

open override fun write(source: Buffer, byteCount: Long)(source)

Removes byteCount bytes from source and appends them to this sink.

Parameters

source

the source to read data from.

byteCount

the number of bytes to write.

Throws

when the source's size is below byteCount or byteCount is negative.

when the sink is closed.

when some I/O error occurs.

-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html b/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html index d125466f..26a611e7 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html +++ b/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/index.html b/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/index.html index d1e19f45..13669ea8 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/index.html +++ b/docs/kotlinx-io-core/kotlinx.io/-e-o-f-exception/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html b/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html index 4d1d3799..7e2e35e1 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html +++ b/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/index.html b/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/index.html index 51456a66..a3647afe 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/index.html +++ b/docs/kotlinx-io-core/kotlinx.io/-i-o-exception/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-internal-io-api/index.html b/docs/kotlinx-io-core/kotlinx.io/-internal-io-api/index.html index b1a28510..33c9cbde 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-internal-io-api/index.html +++ b/docs/kotlinx-io-core/kotlinx.io/-internal-io-api/index.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-raw-sink/close.html b/docs/kotlinx-io-core/kotlinx.io/-raw-sink/close.html index 3989f867..a2ba0692 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-raw-sink/close.html +++ b/docs/kotlinx-io-core/kotlinx.io/-raw-sink/close.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

close

-
expect abstract override fun close()(source)

Pushes all buffered bytes to their final destination and releases the resources held by this sink. It is an error to write a closed sink. It is safe to close a sink more than once.

actual abstract override fun close()(source)
actual abstract override fun close()(source)
actual abstract override fun close()(source)
actual abstract override fun close()(source)
+
expect abstract override fun close()(source)

Pushes all buffered bytes to their final destination and releases the resources held by this sink. It is an error to write a closed sink. It is safe to close a sink more than once.

Throws

when some I/O error occurs.

actual abstract override fun close()(source)
actual abstract override fun close()(source)
actual abstract override fun close()(source)
actual abstract override fun close()(source)
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

flush

-
expect abstract fun flush()(source)

Pushes all buffered bytes to their final destination.

Throws

when the sink is closed.

actual abstract fun flush()(source)
actual abstract override fun flush()(source)
actual abstract fun flush()(source)
actual abstract fun flush()(source)
+
expect abstract fun flush()(source)

Pushes all buffered bytes to their final destination.

Throws

when the sink is closed.

when some I/O error occurs.

actual abstract fun flush()(source)
actual abstract override fun flush()(source)
actual abstract fun flush()(source)
actual abstract fun flush()(source)
-
0.5.3 +
0.5.4
@@ -69,8 +69,7 @@

RawSink

expect interface RawSink : AutoCloseable(source)

Receives a stream of bytes. RawSink is a base interface for kotlinx-io data receivers.

This interface should be implemented to write data wherever it's needed: to the network, storage, or a buffer in memory. Sinks may be layered to transform received data, such as to compress, encrypt, throttle, or add protocol framing.

Most application code shouldn't operate on a raw sink directly, but rather on a buffered Sink which is both more efficient and more convenient. Use buffered to wrap any raw sink with a buffer.

Implementors should abstain from throwing exceptions other than those that are documented for RawSink methods.

Samples

import kotlinx.io.*
-import kotlin.test.Test
-import kotlin.test.assertEquals
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -86,7 +85,7 @@ 

RawSink

private var crc32: UInt = 0xffffffffU private fun update(value: Byte) { - val index = value.xor(crc32.toByte()).toUByte() + val index = value.toUInt().xor(crc32).toUByte() crc32 = crc32Table[index.toInt()].xor(crc32.shr(8)) } @@ -132,7 +131,7 @@

RawSink

assertEquals(0x9896d398U, crc32Sink.crc32()) //sampleEnd -}

Inheritors

actual interface RawSink : AutoCloseable(source)
actual interface RawSink : AutoCloseable, Flushable(source)
actual interface RawSink : AutoCloseable(source)
actual interface RawSink : AutoCloseable(source)
+}

Inheritors

actual interface RawSink : AutoCloseable(source)
actual interface RawSink : AutoCloseable, Flushable(source)
actual interface RawSink : AutoCloseable(source)
actual interface RawSink : AutoCloseable(source)
diff --git a/docs/kotlinx-io-core/kotlinx.io/-raw-sink/write.html b/docs/kotlinx-io-core/kotlinx.io/-raw-sink/write.html index 0b60ffd7..32c066e6 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-raw-sink/write.html +++ b/docs/kotlinx-io-core/kotlinx.io/-raw-sink/write.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -69,7 +69,7 @@

write

-
expect abstract fun write(source: Buffer, byteCount: Long)(source)

Removes byteCount bytes from source and appends them to this sink.

Parameters

source

the source to read data from.

byteCount

the number of bytes to write.

Throws

when the source's size is below byteCount or byteCount is negative.

when the sink is closed.

actual abstract fun write(source: Buffer, byteCount: Long)(source)
actual abstract fun write(source: Buffer, byteCount: Long)(source)
actual abstract fun write(source: Buffer, byteCount: Long)(source)
actual abstract fun write(source: Buffer, byteCount: Long)(source)
+
expect abstract fun write(source: Buffer, byteCount: Long)(source)

Removes byteCount bytes from source and appends them to this sink.

Parameters

source

the source to read data from.

byteCount

the number of bytes to write.

Throws

when the source's size is below byteCount or byteCount is negative.

when the sink is closed.

when some I/O error occurs.

actual abstract fun write(source: Buffer, byteCount: Long)(source)
actual abstract fun write(source: Buffer, byteCount: Long)(source)
actual abstract fun write(source: Buffer, byteCount: Long)(source)
actual abstract fun write(source: Buffer, byteCount: Long)(source)
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

close

-
abstract override fun close()(source)

Closes this source and releases the resources held by this source. It is an error to read a closed source. It is safe to close a source more than once.

+
abstract override fun close()(source)

Closes this source and releases the resources held by this source. It is an error to read a closed source. It is safe to close a source more than once.

Throws

when some I/O error occurs.

-
0.5.3 +
0.5.4
@@ -63,8 +63,7 @@

RawSource

Supplies a stream of bytes. RawSource is a base interface for kotlinx-io data suppliers.

The interface should be implemented to read data from wherever it's located: from the network, storage, or a buffer in memory. Sources may be layered to transform supplied data, such as to decompress, decrypt, or remove protocol framing.

Most applications shouldn't operate on a raw source directly, but rather on a buffered Source which is both more efficient and more convenient. Use buffered to wrap any raw source with a buffer.

Implementors should abstain from throwing exceptions other than those that are documented for RawSource methods.

Samples

import kotlinx.io.*
-import kotlin.test.Test
-import kotlin.test.assertEquals
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-raw-source/read-at-most-to.html b/docs/kotlinx-io-core/kotlinx.io/-raw-source/read-at-most-to.html
index 2f0e0339..115dda97 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-raw-source/read-at-most-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-raw-source/read-at-most-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readAtMostTo

-
abstract fun readAtMostTo(sink: Buffer, byteCount: Long): Long(source)

Removes at least 1, and up to byteCount bytes from this source and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the destination to write the data from this source.

byteCount

the number of bytes to read.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun readAtMostTo(sink: Buffer, byteCount: Long): Long(source)

Removes at least 1, and up to byteCount bytes from this source and appends them to sink. Returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the destination to write the data from this source.

byteCount

the number of bytes to read.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-segment/index.html b/docs/kotlinx-io-core/kotlinx.io/-segment/index.html
index cc26e78f..a0b796b9 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-segment/index.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-segment/index.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/buffer.html b/docs/kotlinx-io-core/kotlinx.io/-sink/buffer.html index e30d494c..1698e2f0 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-sink/buffer.html +++ b/docs/kotlinx-io-core/kotlinx.io/-sink/buffer.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/emit.html b/docs/kotlinx-io-core/kotlinx.io/-sink/emit.html index effd15fa..1a7878b2 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-sink/emit.html +++ b/docs/kotlinx-io-core/kotlinx.io/-sink/emit.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

emit

-
abstract fun emit()(source)

Writes all buffered data to the underlying sink if one exists. The underlying sink will not be explicitly flushed.

This method behaves like flush, but has weaker guarantees. Call this method before a buffered sink goes out of scope so that its data can reach its destination.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun emit()(source)

Writes all buffered data to the underlying sink if one exists. The underlying sink will not be explicitly flushed.

This method behaves like flush, but has weaker guarantees. Call this method before a buffered sink goes out of scope so that its data can reach its destination.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/flush.html b/docs/kotlinx-io-core/kotlinx.io/-sink/flush.html
index f5842a8c..304a1748 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/flush.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/flush.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

flush

-
abstract override fun flush()(source)

Writes all buffered data to the underlying sink, if one exists. Then the underlying sink is explicitly flushed.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract override fun flush()(source)

Writes all buffered data to the underlying sink, if one exists. Then the underlying sink is explicitly flushed.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/hint-emit.html b/docs/kotlinx-io-core/kotlinx.io/-sink/hint-emit.html
index f024cc9f..2031a50a 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/hint-emit.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/hint-emit.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

hintEmit

-
abstract fun hintEmit()(source)

Hints that the buffer may be partially emitted (see emit) to the underlying sink. The underlying sink will not be explicitly flushed. There are no guarantees that this call will cause emit of buffered data as well as there are no guarantees how many bytes will be emitted.

Typically, application code will not need to call this: it is only necessary when application code writes directly to this buffered. Use this to limit the memory held in the buffer.

Consider using Sink.writeToInternalBuffer for writes into buffered followed by hintEmit call.

Throws

when the sink is closed.

+
abstract fun hintEmit()(source)

Hints that the buffer may be partially emitted (see emit) to the underlying sink. The underlying sink will not be explicitly flushed. There are no guarantees that this call will cause emit of buffered data as well as there are no guarantees how many bytes will be emitted.

Typically, application code will not need to call this: it is only necessary when application code writes directly to this buffered. Use this to limit the memory held in the buffer.

Consider using Sink.writeToInternalBuffer for writes into buffered followed by hintEmit call.

Throws

when the sink is closed.

when some I/O error occurs.

-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/transfer-from.html b/docs/kotlinx-io-core/kotlinx.io/-sink/transfer-from.html index ba63456d..cbd3e737 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-sink/transfer-from.html +++ b/docs/kotlinx-io-core/kotlinx.io/-sink/transfer-from.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

transferFrom

-
abstract fun transferFrom(source: RawSource): Long(source)

Removes all bytes from source and write them to this sink. Returns the number of bytes read which will be 0 if source is exhausted.

Parameters

source

the source to consume data from.

Throws

when the sink or source is closed.

Samples

import kotlinx.io.*
+  
abstract fun transferFrom(source: RawSource): Long(source)

Removes all bytes from source and write them to this sink. Returns the number of bytes read which will be 0 if source is exhausted.

Parameters

source

the source to consume data from.

Throws

when the sink or source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/write-byte.html b/docs/kotlinx-io-core/kotlinx.io/-sink/write-byte.html
index 0e2b839a..63d53e5c 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/write-byte.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/write-byte.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeByte

-
abstract fun writeByte(byte: Byte)(source)

Writes a byte to this sink.

Parameters

byte

the byte to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun writeByte(byte: Byte)(source)

Writes a byte to this sink.

Parameters

byte

the byte to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/write-int.html b/docs/kotlinx-io-core/kotlinx.io/-sink/write-int.html
index 015900db..7158a30d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/write-int.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/write-int.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeInt

-
abstract fun writeInt(int: Int)(source)

Writes four bytes containing int, in the big-endian order, to this sink.

Parameters

int

the integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun writeInt(int: Int)(source)

Writes four bytes containing int, in the big-endian order, to this sink.

Parameters

int

the integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/write-long.html b/docs/kotlinx-io-core/kotlinx.io/-sink/write-long.html
index 1654fa0d..7d9a8e4e 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/write-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/write-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeLong

-
abstract fun writeLong(long: Long)(source)

Writes eight bytes containing long, in the big-endian order, to this sink.

Parameters

long

the long integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun writeLong(long: Long)(source)

Writes eight bytes containing long, in the big-endian order, to this sink.

Parameters

long

the long integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/write-short.html b/docs/kotlinx-io-core/kotlinx.io/-sink/write-short.html
index 7a67f8e7..b5b4e042 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/write-short.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/write-short.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeShort

-
abstract fun writeShort(short: Short)(source)

Writes two bytes containing short, in the big-endian order, to this sink.

Parameters

short

the short integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun writeShort(short: Short)(source)

Writes two bytes containing short, in the big-endian order, to this sink.

Parameters

short

the short integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-sink/write.html b/docs/kotlinx-io-core/kotlinx.io/-sink/write.html
index e989da96..41709106 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-sink/write.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-sink/write.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

write

-
abstract fun write(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size)(source)

Writes bytes from source array or its subrange to this sink.

Parameters

source

the array from which bytes will be written into this sink.

startIndex

the start index (inclusive) of the source subrange to be written, 0 by default.

endIndex

the endIndex (exclusive) of the source subrange to be written, size of the source by default.

Throws

when startIndex or endIndex is out of range of source array indices.

when startIndex > endIndex.

when the sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun write(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size)(source)

Writes bytes from source array or its subrange to this sink.

Parameters

source

the array from which bytes will be written into this sink.

startIndex

the start index (inclusive) of the source subrange to be written, 0 by default.

endIndex

the endIndex (exclusive) of the source subrange to be written, size of the source by default.

Throws

when startIndex or endIndex is out of range of source array indices.

when startIndex > endIndex.

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -76,7 +76,7 @@ 

write

sink.write(byteArrayOf(1, 2, 3, 4), startIndex = 1, endIndex = 3) assertContentEquals(byteArrayOf(2, 3), sink.readByteArray()) //sampleEnd -}

abstract fun write(source: RawSource, byteCount: Long)(source)

Removes byteCount bytes from source and write them to this sink.

If source will be exhausted before reading byteCount from it then an exception throws on an attempt to read remaining bytes will be propagated to a caller of this method.

Parameters

source

the source to consume data from.

byteCount

the number of bytes to read from source and to write into this sink.

Throws

when the sink or source is closed.

Samples

import kotlinx.io.*
+}

abstract fun write(source: RawSource, byteCount: Long)(source)

Removes byteCount bytes from source and write them to this sink.

If source will be exhausted before reading byteCount from it then an exception throws on an attempt to read remaining bytes will be propagated to a caller of this method.

Parameters

source

the source to consume data from.

byteCount

the number of bytes to read from source and to write into this sink.

Throws

when the sink or source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/buffer.html b/docs/kotlinx-io-core/kotlinx.io/-source/buffer.html
index 6edf84b5..6b258b80 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/buffer.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/buffer.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/exhausted.html b/docs/kotlinx-io-core/kotlinx.io/-source/exhausted.html index 895fca52..aeb98271 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-source/exhausted.html +++ b/docs/kotlinx-io-core/kotlinx.io/-source/exhausted.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

exhausted

-
abstract fun exhausted(): Boolean(source)

Returns true if there are no more bytes in this source.

The call of this method will block until there are bytes to read or the source is definitely exhausted.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun exhausted(): Boolean(source)

Returns true if there are no more bytes in this source.

The call of this method will block until there are bytes to read or the source is definitely exhausted.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/index.html b/docs/kotlinx-io-core/kotlinx.io/-source/index.html
index 409398f8..a26334eb 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/index.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/index.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/peek.html b/docs/kotlinx-io-core/kotlinx.io/-source/peek.html index 20d8e54a..886680c7 100644 --- a/docs/kotlinx-io-core/kotlinx.io/-source/peek.html +++ b/docs/kotlinx-io-core/kotlinx.io/-source/peek.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

peek

-
abstract fun peek(): Source(source)

Returns a new Source that can read data from this source without consuming it. The returned source becomes invalid once this source is next read or closed.

Peek could be used to lookahead and read the same data multiple times.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun peek(): Source(source)

Returns a new Source that can read data from this source without consuming it. The returned source becomes invalid once this source is next read or closed.

Peek could be used to lookahead and read the same data multiple times.

Throws

when the source is closed.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/read-at-most-to.html b/docs/kotlinx-io-core/kotlinx.io/-source/read-at-most-to.html
index 1307fef1..e2e510cd 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/read-at-most-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/read-at-most-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readAtMostTo

-
abstract fun readAtMostTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size): Int(source)

Removes up to endIndex - startIndex bytes from this source, copies them into sink subrange starting at startIndex and ending at endIndex, and returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the array to which data will be written from this source.

startIndex

the startIndex (inclusive) of the sink subrange to read data into, 0 by default.

endIndex

the endIndex (exclusive) of the sink subrange to read data into, sink.size by default.

Throws

when startIndex or endIndex is out of range of sink array indices.

when startIndex > endIndex.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun readAtMostTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size): Int(source)

Removes up to endIndex - startIndex bytes from this source, copies them into sink subrange starting at startIndex and ending at endIndex, and returns the number of bytes read, or -1 if this source is exhausted.

Parameters

sink

the array to which data will be written from this source.

startIndex

the startIndex (inclusive) of the sink subrange to read data into, 0 by default.

endIndex

the endIndex (exclusive) of the sink subrange to read data into, sink.size by default.

Throws

when startIndex or endIndex is out of range of sink array indices.

when startIndex > endIndex.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/read-byte.html b/docs/kotlinx-io-core/kotlinx.io/-source/read-byte.html
index a6ef5cf4..58eeb20d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/read-byte.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/read-byte.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readByte

-
abstract fun readByte(): Byte(source)

Removes a byte from this source and returns it.

Throws

when there are no more bytes to read.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun readByte(): Byte(source)

Removes a byte from this source and returns it.

Throws

when there are no more bytes to read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/read-int.html b/docs/kotlinx-io-core/kotlinx.io/-source/read-int.html
index 519b842b..b0d9a348 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/read-int.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/read-int.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readInt

-
abstract fun readInt(): Int(source)

Removes four bytes from this source and returns an integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an int value.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun readInt(): Int(source)

Removes four bytes from this source and returns an integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/read-long.html b/docs/kotlinx-io-core/kotlinx.io/-source/read-long.html
index 9f34d1f2..1147c897 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/read-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/read-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readLong

-
abstract fun readLong(): Long(source)

Removes eight bytes from this source and returns a long integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a long value.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun readLong(): Long(source)

Removes eight bytes from this source and returns a long integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a long value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/read-short.html b/docs/kotlinx-io-core/kotlinx.io/-source/read-short.html
index 4266b277..fbacb660 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/read-short.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/read-short.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readShort

-
abstract fun readShort(): Short(source)

Removes two bytes from this source and returns a short integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a short value.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun readShort(): Short(source)

Removes two bytes from this source and returns a short integer composed of it according to the big-endian order.

Throws

when there are not enough data to read a short value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/read-to.html b/docs/kotlinx-io-core/kotlinx.io/-source/read-to.html
index 472c6683..3b806e7a 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/read-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/read-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readTo

-
abstract fun readTo(sink: RawSink, byteCount: Long)(source)

Removes exactly byteCount bytes from this source and writes them to sink.

Parameters

sink

the sink to which data will be written from this source.

byteCount

the number of bytes that should be written into sink

Throws

when the requested number of bytes cannot be read.

when the source or sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun readTo(sink: RawSink, byteCount: Long)(source)

Removes exactly byteCount bytes from this source and writes them to sink.

Parameters

sink

the sink to which data will be written from this source.

byteCount

the number of bytes that should be written into sink

Throws

when the requested number of bytes cannot be read.

when the source or sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/request.html b/docs/kotlinx-io-core/kotlinx.io/-source/request.html
index 9b3839aa..40a4b723 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/request.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/request.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

request

-
abstract fun request(byteCount: Long): Boolean(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and returns a value indicating if the requirement was successfully fulfilled.

false value returned by this method indicates that the underlying source was exhausted before filling the buffer with byteCount bytes of data.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun request(byteCount: Long): Boolean(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and returns a value indicating if the requirement was successfully fulfilled.

false value returned by this method indicates that the underlying source was exhausted before filling the buffer with byteCount bytes of data.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/require.html b/docs/kotlinx-io-core/kotlinx.io/-source/require.html
index fd2aba10..98628f0e 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/require.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/require.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

require

-
abstract fun require(byteCount: Long)(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and throw EOFException when the source is exhausted before fulfilling the requirement.

If the buffer already contains required number of bytes then there will be no requests to the underlying source.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is exhausted before the required bytes count could be read.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun require(byteCount: Long)(source)

Attempts to fill the buffer with at least byteCount bytes of data from the underlying source and throw EOFException when the source is exhausted before fulfilling the requirement.

If the buffer already contains required number of bytes then there will be no requests to the underlying source.

Parameters

byteCount

the number of bytes that the buffer should contain.

Throws

when the source is exhausted before the required bytes count could be read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/skip.html b/docs/kotlinx-io-core/kotlinx.io/-source/skip.html
index fcd31e78..d971f94d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/skip.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/skip.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

skip

-
abstract fun skip(byteCount: Long)(source)

Reads and discards byteCount bytes from this source.

Parameters

byteCount

the number of bytes to be skipped.

Throws

when the source is exhausted before the requested number of bytes can be skipped.

when the source is closed.

Samples

import kotlinx.io.*
+  
abstract fun skip(byteCount: Long)(source)

Reads and discards byteCount bytes from this source.

Parameters

byteCount

the number of bytes to be skipped.

Throws

when the source is exhausted before the requested number of bytes can be skipped.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-source/transfer-to.html b/docs/kotlinx-io-core/kotlinx.io/-source/transfer-to.html
index 4f9da0bb..2a155d11 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-source/transfer-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-source/transfer-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

transferTo

-
abstract fun transferTo(sink: RawSink): Long(source)

Removes all bytes from this source, writes them to sink, and returns the total number of bytes written to sink.

Return 0 if this source is exhausted.

Parameters

sink

the sink to which data will be written from this source.

Throws

when the source or sink is closed.

Samples

import kotlinx.io.*
+  
abstract fun transferTo(sink: RawSink): Long(source)

Removes all bytes from this source, writes them to sink, and returns the total number of bytes written to sink.

Return 0 if this source is exhausted.

Parameters

sink

the sink to which data will be written from this source.

Throws

when the source or sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/-unsafe-io-api/index.html b/docs/kotlinx-io-core/kotlinx.io/-unsafe-io-api/index.html
index 80f7b52a..d81f622b 100644
--- a/docs/kotlinx-io-core/kotlinx.io/-unsafe-io-api/index.html
+++ b/docs/kotlinx-io-core/kotlinx.io/-unsafe-io-api/index.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/as-byte-channel.html b/docs/kotlinx-io-core/kotlinx.io/as-byte-channel.html index 63c7a095..ce98c26b 100644 --- a/docs/kotlinx-io-core/kotlinx.io/as-byte-channel.html +++ b/docs/kotlinx-io-core/kotlinx.io/as-byte-channel.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -65,7 +65,7 @@

asByteChannel<

-

Returns a new ByteChannel instance representing this buffer.


Returns WritableByteChannel backed by this sink. Closing the channel will also close the sink.


Returns ReadableByteChannel backed by this source. Closing the source will close the source.

+

Returns a new ByteChannel instance representing this buffer.


Returns WritableByteChannel backed by this sink. Closing the channel will also close the sink.


Returns ReadableByteChannel backed by this source. Closing the source will close the source.

-
0.5.3 +
0.5.4
@@ -65,16 +65,13 @@

asInputStream<

-

Returns an input stream that reads from this source. Closing the stream will also close this source.

Samples

import kotlinx.io.*
+

Returns an input stream that reads from this source. Closing the stream will also close this source.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/as-n-s-input-stream.html b/docs/kotlinx-io-core/kotlinx.io/as-n-s-input-stream.html
index b4ebed50..1b0f520f 100644
--- a/docs/kotlinx-io-core/kotlinx.io/as-n-s-input-stream.html
+++ b/docs/kotlinx-io-core/kotlinx.io/as-n-s-input-stream.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/as-n-s-output-stream.html b/docs/kotlinx-io-core/kotlinx.io/as-n-s-output-stream.html index b65749ec..b4b90a01 100644 --- a/docs/kotlinx-io-core/kotlinx.io/as-n-s-output-stream.html +++ b/docs/kotlinx-io-core/kotlinx.io/as-n-s-output-stream.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/as-output-stream.html b/docs/kotlinx-io-core/kotlinx.io/as-output-stream.html index 8eea3b6f..276e1f44 100644 --- a/docs/kotlinx-io-core/kotlinx.io/as-output-stream.html +++ b/docs/kotlinx-io-core/kotlinx.io/as-output-stream.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -65,16 +65,13 @@

asOutputStream

-

Returns an output stream that writes to this sink. Closing the stream will also close this sink.

Samples

import kotlinx.io.*
+

Returns an output stream that writes to this sink. Closing the stream will also close this sink.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/as-sink.html b/docs/kotlinx-io-core/kotlinx.io/as-sink.html
index 9ad19cbb..783f7a42 100644
--- a/docs/kotlinx-io-core/kotlinx.io/as-sink.html
+++ b/docs/kotlinx-io-core/kotlinx.io/as-sink.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -66,7 +66,7 @@

asSink

-
fun NSOutputStream.asSink(): RawSink(source)

Returns RawSink that writes to an output stream.

Use RawSink.buffered to create a buffered sink from it.

Samples

import kotlinx.cinterop.*
+
fun NSOutputStream.asSink(): RawSink(source)

Returns RawSink that writes to an output stream.

Use RawSink.buffered to create a buffered sink from it.

Samples

import kotlinx.cinterop.*
 import kotlinx.io.*
 import platform.Foundation.*
 import kotlin.test.Test
@@ -84,16 +84,13 @@ 

asSink

val writtenData = outputStream.propertyForKey(NSStreamDataWrittenToMemoryStreamKey) as NSData assertContentEquals(data, writtenData.toByteArray()) //sampleEnd -}

Returns RawSink that writes to an output stream.

Use RawSink.buffered to create a buffered sink from it.

Samples

import kotlinx.io.*
+}

Returns RawSink that writes to an output stream.

Use RawSink.buffered to create a buffered sink from it.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/as-source.html b/docs/kotlinx-io-core/kotlinx.io/as-source.html
index ba247712..47254f27 100644
--- a/docs/kotlinx-io-core/kotlinx.io/as-source.html
+++ b/docs/kotlinx-io-core/kotlinx.io/as-source.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -80,16 +80,13 @@

asSource

val receivedData = inputStream.asSource().buffered().readByteArray() assertContentEquals(data, receivedData) //sampleEnd -}

Returns RawSource that reads from an input stream.

Use RawSource.buffered to create a buffered source from it.

Samples

import kotlinx.io.*
+}

Returns RawSource that reads from an input stream.

Use RawSource.buffered to create a buffered source from it.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/buffered.html b/docs/kotlinx-io-core/kotlinx.io/buffered.html
index 48063df0..95dfc3f8 100644
--- a/docs/kotlinx-io-core/kotlinx.io/buffered.html
+++ b/docs/kotlinx-io-core/kotlinx.io/buffered.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/copy-to.html b/docs/kotlinx-io-core/kotlinx.io/copy-to.html index 8daf9b21..e656a4e9 100644 --- a/docs/kotlinx-io-core/kotlinx.io/copy-to.html +++ b/docs/kotlinx-io-core/kotlinx.io/copy-to.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -65,16 +65,13 @@

copyTo

-
fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)(source)

Copy bytes from this buffer's subrange, starting at startIndex and ending at endIndex, to out. This method does not consume data from the buffer.

Parameters

out

the destination to copy data into.

startIndex

the index (inclusive) of the first byte to copy, 0 by default.

endIndex

the index (exclusive) of the last byte to copy, buffer.size by default.

Throws

when startIndex or endIndex is out of this buffer bounds ([0..buffer.size)).

when startIndex > endIndex.

Samples

import kotlinx.io.*
+
fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)(source)

Copies bytes from this buffer's subrange, starting at startIndex and ending at endIndex, to out. This method does not consume data from the buffer.

Parameters

out

the destination to copy data into.

startIndex

the index (inclusive) of the first byte to copy, 0 by default.

endIndex

the index (exclusive) of the last byte to copy, buffer.size by default.

Throws

when startIndex or endIndex is out of this buffer bounds ([0..buffer.size)).

when startIndex > endIndex.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/discarding-sink.html b/docs/kotlinx-io-core/kotlinx.io/discarding-sink.html
index 19d1a769..5fce587e 100644
--- a/docs/kotlinx-io-core/kotlinx.io/discarding-sink.html
+++ b/docs/kotlinx-io-core/kotlinx.io/discarding-sink.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
diff --git a/docs/kotlinx-io-core/kotlinx.io/index-of.html b/docs/kotlinx-io-core/kotlinx.io/index-of.html index a4067052..4bbd11e4 100644 --- a/docs/kotlinx-io-core/kotlinx.io/index-of.html +++ b/docs/kotlinx-io-core/kotlinx.io/index-of.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -77,12 +77,10 @@

indexOf

assertEquals(20, buffer.indexOf('\n'.code.toByte(), startIndex = 6)) assertEquals(-1, buffer.indexOf('\n'.code.toByte(), startIndex = 21)) //sampleEnd -}

fun Source.indexOf(byteString: ByteString, startIndex: Long = 0): Long(source)

Returns the index of the first match for byteString in the source at or after startIndex. This expands the source's buffer as necessary until byteString is found. This reads an unbounded number of bytes into the buffer. Returns -1 if the stream is exhausted before the requested bytes are found.

Parameters

byteString

the sequence of bytes to find within the source.

startIndex

the index into the source to start searching from.

Throws

if the source is closed.

Samples

import kotlinx.io.*
+}

fun Source.indexOf(byteString: ByteString, startIndex: Long = 0): Long(source)

Returns the index of the first match for byteString in the source at or after startIndex. This expands the source's buffer as necessary until byteString is found. This reads an unbounded number of bytes into the buffer. Returns -1 if the stream is exhausted before the requested bytes are found.

Parameters

byteString

the sequence of bytes to find within the source.

startIndex

the index into the source to start searching from.

Throws

if the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlinx.io.bytestring.ByteString
 import kotlinx.io.bytestring.encodeToByteString
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -96,7 +94,7 @@ 

indexOf

assertEquals(43, buffer.indexOf("\n\n".encodeToByteString())) assertEquals(-1, buffer.indexOf("application/json".encodeToByteString())) //sampleEnd -}

fun Buffer.indexOf(byteString: ByteString, startIndex: Long = 0): Long(source)


fun Source.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = Long.MAX_VALUE): Long(source)

Returns an index of byte first occurrence in the range of startIndex to endIndex, or -1 when the range doesn't contain byte.

The scan terminates at either endIndex or source's exhaustion, whichever comes first. The maximum number of bytes scanned is toIndex-fromIndex. If byte not found in buffered data, endIndex is yet to be reached and the underlying source is not yet exhausted then new data will be read from the underlying source into the buffer.

Parameters

byte

the value to find.

startIndex

the start of the range (inclusive) to find byte, 0 by default.

endIndex

the end of the range (exclusive) to find byte, Long.MAX_VALUE by default.

Throws

when the source is closed.

when startIndex > endIndex or either of indices is negative.

Samples

import kotlinx.io.*
+}

fun Buffer.indexOf(byteString: ByteString, startIndex: Long = 0): Long(source)


fun Source.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = Long.MAX_VALUE): Long(source)

Returns an index of byte first occurrence in the range of startIndex to endIndex, or -1 when the range doesn't contain byte.

The scan terminates at either endIndex or source's exhaustion, whichever comes first. The maximum number of bytes scanned is toIndex-fromIndex. If byte not found in buffered data, endIndex is yet to be reached and the underlying source is not yet exhausted then new data will be read from the underlying source into the buffer.

Parameters

byte

the value to find.

startIndex

the start of the range (inclusive) to find byte, 0 by default.

endIndex

the end of the range (exclusive) to find byte, Long.MAX_VALUE by default.

Throws

when the source is closed.

when startIndex > endIndex or either of indices is negative.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/index.html b/docs/kotlinx-io-core/kotlinx.io/index.html
index dd0462cd..38b105bb 100644
--- a/docs/kotlinx-io-core/kotlinx.io/index.html
+++ b/docs/kotlinx-io-core/kotlinx.io/index.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -397,7 +397,7 @@

Functions

-
fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)

Copy bytes from this buffer's subrange, starting at startIndex and ending at endIndex, to out. This method does not consume data from the buffer.

+
fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)

Copies bytes from this buffer's subrange, starting at startIndex and ending at endIndex, to out. This method does not consume data from the buffer.

@@ -840,7 +840,7 @@

Functions

-

Read and exhaust bytes from input into this buffer. Stops reading data on input exhaustion.

Reads all data from source into this buffer.

+

Reads and exhausts bytes from input into this buffer. Stops reading data on input exhaustion.

Reads all data from source into this buffer.

@@ -857,7 +857,7 @@

Functions

-
fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)

Writes subsequence of data from byteString starting at startIndex and ending at endIndex into a sink.

fun Sink.write(source: ByteBuffer): Int

Writes data from the source into this sink and returns the number of bytes written.

fun Buffer.write(input: InputStream, byteCount: Long): Buffer

Read byteCount bytes from input into this buffer. Throws an exception when input is exhausted before reading byteCount bytes.

+
fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)

Writes subsequence of data from byteString starting at startIndex and ending at endIndex into a sink.

fun Sink.write(source: ByteBuffer): Int

Writes data from the source into this sink and returns the number of bytes written.

fun Buffer.write(input: InputStream, byteCount: Long): Buffer

Reads byteCount bytes from input into this buffer. Throws an exception when input is exhausted before reading byteCount bytes.

diff --git a/docs/kotlinx-io-core/kotlinx.io/read-at-most-to.html b/docs/kotlinx-io-core/kotlinx.io/read-at-most-to.html index 7189f0a3..00b6f8cc 100644 --- a/docs/kotlinx-io-core/kotlinx.io/read-at-most-to.html +++ b/docs/kotlinx-io-core/kotlinx.io/read-at-most-to.html @@ -41,7 +41,7 @@ kotlinx-io
-
0.5.3 +
0.5.4
@@ -65,16 +65,13 @@

readAtMost
-

Writes up to ByteBuffer.remaining bytes from this buffer to the sink. Return the number of bytes written.

Parameters

sink

the sink to write data to.

Samples

import kotlinx.io.*
+

Writes up to ByteBuffer.remaining bytes from this buffer to the sink. Return the number of bytes written.

Parameters

sink

the sink to write data to.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -93,16 +90,13 @@ 

readAtMost


Reads at most ByteBuffer.remaining bytes from this source into sink and returns the number of bytes read.

Parameters

sink

the sink to write the data to.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+}

Reads at most ByteBuffer.remaining bytes from this source into sink and returns the number of bytes read.

Parameters

sink

the sink to write the data to.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-byte-array.html b/docs/kotlinx-io-core/kotlinx.io/read-byte-array.html
index 6e4627d7..d79ce554 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-byte-array.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-byte-array.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readByteArray

-

Removes all bytes from this source and returns them as a byte array.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes all bytes from this source and returns them as a byte array.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -76,7 +76,7 @@ 

readByteArray< assertContentEquals(byteArrayOf(0, 1, 2, 3, 0, 0, 0, 0, 0, 0), out) assertContentEquals(byteArrayOf(4, 5, 6, 7), buffer.readByteArray()) //sampleEnd -}


Removes byteCount bytes from this source and returns them as a byte array.

Parameters

byteCount

the number of bytes that should be read from the source.

Throws

when the underlying source is exhausted before byteCount bytes of data could be read.

when the source is closed.

Samples

import kotlinx.io.*
+}

Removes byteCount bytes from this source and returns them as a byte array.

Parameters

byteCount

the number of bytes that should be read from the source.

Throws

when the underlying source is exhausted before byteCount bytes of data could be read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-byte-string.html b/docs/kotlinx-io-core/kotlinx.io/read-byte-string.html
index b77d5f9a..28da07be 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-byte-string.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-byte-string.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,12 +63,10 @@

readByteString

-

Consumes all bytes from this source and wraps it into a byte string.

Throws

if the source is closed.

Samples

import kotlinx.io.*
+  

Consumes all bytes from this source and wraps it into a byte string.

Throws

if the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlinx.io.bytestring.ByteString
 import kotlinx.io.bytestring.encodeToByteString
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -78,12 +76,10 @@ 

readByteString assertEquals(ByteString(3, 4, 5), buffer.readByteString()) // reads until exhaustion assertTrue(buffer.exhausted()) //sampleEnd -}


Consumes exactly byteCount bytes from this source and wraps it into a byte string.

Parameters

byteCount

the number of bytes to read from the source.

Throws

when the source is exhausted before reading byteCount bytes from it.

if the source is closed.

Samples

import kotlinx.io.*
+}

Consumes exactly byteCount bytes from this source and wraps it into a byte string.

Parameters

byteCount

the number of bytes to read from the source.

Throws

when the source is exhausted before reading byteCount bytes from it.

if the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlinx.io.bytestring.ByteString
 import kotlinx.io.bytestring.encodeToByteString
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-code-point-value.html b/docs/kotlinx-io-core/kotlinx.io/read-code-point-value.html
index 998de415..e444d018 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-code-point-value.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-code-point-value.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readCodePointValue

-

Decodes a single code point value from UTF-8 code units, reading between 1 and 4 bytes as necessary.

If this source is exhausted before a complete code point can be read, this throws an EOFException and consumes no input.

If this source starts with an ill-formed UTF-8 code units sequence, this method will remove 1 or more non-UTF-8 bytes and return the replacement character (U+fffd).

The replacement character (U+fffd) will be also returned if the source starts with a well-formed code units sequences, but a decoded value does not pass further validation, such as the value is out of range (beyond the 0x10ffff limit of Unicode), maps to UTF-16 surrogates (U+d800..U+dfff), or an overlong encoding is detected (such as 0xc080 for the NUL character in modified UTF-8).

Note that in general, returned value may not be directly converted to Char as it may be out of Char's values range and should be manually converted to a surrogate pair.

Throws

when the source is exhausted before a complete code point can be read.

when the source is closed.

Samples

import kotlinx.io.*
+  

Decodes a single code point value from UTF-8 code units, reading between 1 and 4 bytes as necessary.

If this source is exhausted before a complete code point can be read, this throws an EOFException and consumes no input.

If this source starts with an ill-formed UTF-8 code units sequence, this method will remove 1 or more non-UTF-8 bytes and return the replacement character (U+fffd).

The replacement character (U+fffd) will be also returned if the source starts with a well-formed code units sequences, but a decoded value does not pass further validation, such as the value is out of range (beyond the 0x10ffff limit of Unicode), maps to UTF-16 surrogates (U+d800..U+dfff), or an overlong encoding is detected (such as 0xc080 for the NUL character in modified UTF-8).

Note that in general, returned value may not be directly converted to Char as it may be out of Char's values range and should be manually converted to a surrogate pair.

Throws

when the source is exhausted before a complete code point can be read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-decimal-long.html b/docs/kotlinx-io-core/kotlinx.io/read-decimal-long.html
index 4f2a664d..cf9046ee 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-decimal-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-decimal-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readDecimalLong

-

Reads a long from this source in signed decimal form (i.e., as a string in base 10 with optional leading -).

Source data will be consumed until the source is exhausted, the first occurrence of non-digit byte, or overflow happened during resulting value construction.

Throws

if the found digits do not fit into a long or a decimal number was not present.

if the source is exhausted before a call of this method.

when the source is closed.

Samples

import kotlinx.io.*
+  

Reads a long from this source in signed decimal form (i.e., as a string in base 10 with optional leading -).

Source data will be consumed until the source is exhausted, the first occurrence of non-digit byte, or overflow happened during resulting value construction.

Throws

if the found digits do not fit into a long or a decimal number was not present.

if the source is exhausted before a call of this method.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-double-le.html b/docs/kotlinx-io-core/kotlinx.io/read-double-le.html
index e4438cd8..02645e51 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-double-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-double-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readDoubleLe

-

Removes eight bytes from this source and returns a floating point number with type Double composed of it according to the little-endian order.

The Double.Companion.fromBits function is used for decoding bytes into Double.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes eight bytes from this source and returns a floating point number with type Double composed of it according to the little-endian order.

The Double.Companion.fromBits function is used for decoding bytes into Double.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-double.html b/docs/kotlinx-io-core/kotlinx.io/read-double.html
index c3ea5918..c9ccd0de 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-double.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-double.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readDouble

-

Removes eight bytes from this source and returns a floating point number with type Double composed of it according to the big-endian order.

The Double.Companion.fromBits function is used for decoding bytes into Double.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes eight bytes from this source and returns a floating point number with type Double composed of it according to the big-endian order.

The Double.Companion.fromBits function is used for decoding bytes into Double.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-float-le.html b/docs/kotlinx-io-core/kotlinx.io/read-float-le.html
index b5e9b4a4..c03ad88e 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-float-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-float-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readFloatLe

-

Removes four bytes from this source and returns a floating point number with type Float composed of it according to the little-endian order.

The Float.Companion.fromBits function is used for decoding bytes into Float.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloatLe and then reading it back using Source.readFloatLe may not be equal to the original value. Please refer to Float.Companion.fromBits documentation for details.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes four bytes from this source and returns a floating point number with type Float composed of it according to the little-endian order.

The Float.Companion.fromBits function is used for decoding bytes into Float.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloatLe and then reading it back using Source.readFloatLe may not be equal to the original value. Please refer to Float.Companion.fromBits documentation for details.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-float.html b/docs/kotlinx-io-core/kotlinx.io/read-float.html
index 57ed08ef..8e57b3c8 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-float.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-float.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readFloat

-

Removes four bytes from this source and returns a floating point number with type Float composed of it according to the big-endian order.

The Float.Companion.fromBits function is used for decoding bytes into Float.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloat and then reading it back using Source.readFloat may not be equal to the original value. Please refer to Float.Companion.fromBits documentation for details.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes four bytes from this source and returns a floating point number with type Float composed of it according to the big-endian order.

The Float.Companion.fromBits function is used for decoding bytes into Float.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloat and then reading it back using Source.readFloat may not be equal to the original value. Please refer to Float.Companion.fromBits documentation for details.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-hexadecimal-unsigned-long.html b/docs/kotlinx-io-core/kotlinx.io/read-hexadecimal-unsigned-long.html
index 18ac1306..dec6394d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-hexadecimal-unsigned-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-hexadecimal-unsigned-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readHexadecimalUnsignedLong

-

Reads a long form this source in hexadecimal form (i.e., as a string in base 16).

Source data will be consumed until the source is exhausted, the first occurrence of non-digit byte, or overflow happened during resulting value construction.

Throws

if the found hexadecimal does not fit into a long or hexadecimal was not found.

if the source is exhausted before a call of this method.

when the source is closed.

Samples

import kotlinx.io.*
+  

Reads a long form this source in hexadecimal form (i.e., as a string in base 16).

Source data will be consumed until the source is exhausted, the first occurrence of non-digit byte, or overflow happened during resulting value construction.

Throws

if the found hexadecimal does not fit into a long or hexadecimal was not found.

if the source is exhausted before a call of this method.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-int-le.html b/docs/kotlinx-io-core/kotlinx.io/read-int-le.html
index ca2bbf3b..cb722480 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-int-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-int-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readIntLe

-

Removes four bytes from this source and returns an integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes four bytes from this source and returns an integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-line-strict.html b/docs/kotlinx-io-core/kotlinx.io/read-line-strict.html
index 241cd366..ebb8e0f5 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-line-strict.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-line-strict.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readLineStrict

-
fun Source.readLineStrict(limit: Long = Long.MAX_VALUE): String(source)

Removes and returns UTF-8 encoded characters up to but not including the next line break, throwing EOFException if a line break was not encountered. A line break is either "\n" or "\r\n"; these characters are not included in the result.

The returned string will have at most limit UTF-8 bytes, and the maximum number of bytes scanned is limit + 2. If limit == 0 this will always throw an EOFException because no bytes will be scanned.

No bytes are discarded if the match fails.

Parameters

limit

the maximum UTF-8 bytes constituting a returned string.

Throws

when the source does not contain a string consisting with at most limit bytes followed by line break characters.

when the source is closed.

Samples

import kotlinx.io.*
+  
fun Source.readLineStrict(limit: Long = Long.MAX_VALUE): String(source)

Removes and returns UTF-8 encoded characters up to but not including the next line break, throwing EOFException if a line break was not encountered. A line break is either "\n" or "\r\n"; these characters are not included in the result.

The returned string will have at most limit UTF-8 bytes, and the maximum number of bytes scanned is limit + 2. If limit == 0 this will always throw an EOFException because no bytes will be scanned.

No bytes are discarded if the match fails.

Parameters

limit

the maximum UTF-8 bytes constituting a returned string.

Throws

when the source does not contain a string consisting with at most limit bytes followed by line break characters.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-line.html b/docs/kotlinx-io-core/kotlinx.io/read-line.html
index bae59e56..47a8193d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-line.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-line.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readLine

-

Removes and returns UTF-8 encoded characters up to but not including the next line break. A line break is either "\n" or "\r\n"; these characters are not included in the result.

On the end of the stream this method returns null. If the source doesn't end with a line break, then an implicit line break is assumed. Null is returned once the source is exhausted.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes and returns UTF-8 encoded characters up to but not including the next line break. A line break is either "\n" or "\r\n"; these characters are not included in the result.

On the end of the stream this method returns null. If the source doesn't end with a line break, then an implicit line break is assumed. Null is returned once the source is exhausted.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-long-le.html b/docs/kotlinx-io-core/kotlinx.io/read-long-le.html
index 6a73660f..e8c5a70d 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-long-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-long-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readLongLe

-

Removes eight bytes from this source and returns a long integer composed of it according to the little-endian order.

Throws

when there are not enough data to read a long value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes eight bytes from this source and returns a long integer composed of it according to the little-endian order.

Throws

when there are not enough data to read a long value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-short-le.html b/docs/kotlinx-io-core/kotlinx.io/read-short-le.html
index 56c9ccea..05836cf4 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-short-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-short-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readShortLe

-

Removes two bytes from this source and returns a short integer composed of it according to the little-endian order.

Throws

when there are not enough data to read a short value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes two bytes from this source and returns a short integer composed of it according to the little-endian order.

Throws

when there are not enough data to read a short value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-string.html b/docs/kotlinx-io-core/kotlinx.io/read-string.html
index 0931e7f9..9eed7012 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-string.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-string.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -66,7 +66,7 @@

readString

-

Removes all bytes from this source, decodes them as UTF-8, and returns the string.

Returns the empty string if this source is empty.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+

Removes all bytes from this source, decodes them as UTF-8, and returns the string.

Returns the empty string if this source is empty.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -80,7 +80,7 @@ 

readString

buffer.write(byteArrayOf(0xce.toByte(), 0x94.toByte())) assertEquals("Δ", buffer.readString()) //sampleEnd -}

Removes all bytes from this buffer, decodes them as UTF-8, and returns the string.

Returns the empty string if this buffer is empty.

Samples

import kotlinx.io.*
+}

Removes all bytes from this buffer, decodes them as UTF-8, and returns the string.

Returns the empty string if this buffer is empty.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -94,7 +94,7 @@ 

readString

buffer.write(byteArrayOf(0xce.toByte(), 0x94.toByte())) assertEquals("Δ", buffer.readString()) //sampleEnd -}

fun Source.readString(byteCount: Long): String(source)

Removes byteCount bytes from this source, decodes them as UTF-8, and returns the string.

Parameters

byteCount

the number of bytes to read from the source for string decoding.

Throws

when the source is exhausted before reading byteCount bytes from it.

when the source is closed.

Samples

import kotlinx.io.*
+}

fun Source.readString(byteCount: Long): String(source)

Removes byteCount bytes from this source, decodes them as UTF-8, and returns the string.

Parameters

byteCount

the number of bytes to read from the source for string decoding.

Throws

when the source is exhausted before reading byteCount bytes from it.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -108,16 +108,13 @@ 

readString

buffer.write(byteArrayOf(0xce.toByte(), 0x94.toByte())) assertEquals("Δ", buffer.readString()) //sampleEnd -}

Decodes whole content of this stream into a string using charset. Returns empty string if the source is exhausted.

Parameters

charset

the Charset to use for string decoding.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+}

Decodes whole content of this stream into a string using charset. Returns empty string if the source is exhausted.

Parameters

charset

the Charset to use for string decoding.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -129,16 +126,13 @@ 

readString

buffer.writeString("hi", Charsets.UTF_16BE) assertContentEquals(byteArrayOf(0, 0x68, 0, 0x69), buffer.readByteArray()) //sampleEnd -}

fun Source.readString(byteCount: Long, charset: Charset): String(source)

Decodes byteCount bytes of this stream into a string using charset.

Parameters

byteCount

the number of bytes to read from the source for decoding.

charset

the Charset to use for string decoding.

Throws

when the source exhausted before byteCount bytes could be read from it.

when the source is closed.

if byteCount is negative or its value is greater than Int.MAX_VALUE.

Samples

import kotlinx.io.*
+}

fun Source.readString(byteCount: Long, charset: Charset): String(source)

Decodes byteCount bytes of this stream into a string using charset.

Parameters

byteCount

the number of bytes to read from the source for decoding.

charset

the Charset to use for string decoding.

Throws

when the source exhausted before byteCount bytes could be read from it.

when the source is closed.

if byteCount is negative or its value is greater than Int.MAX_VALUE.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-to.html b/docs/kotlinx-io-core/kotlinx.io/read-to.html
index f8c7c19f..b882a8f0 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-to.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-to.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -66,7 +66,7 @@

readTo

-
fun Source.readTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size)(source)

Removes exactly endIndex - startIndex bytes from this source and copies them into sink subrange starting at startIndex and ending at endIndex.

Parameters

sink

the array to write data to

startIndex

the startIndex (inclusive) of the sink subrange to read data into, 0 by default.

endIndex

the endIndex (exclusive) of the sink subrange to read data into, sink.size by default.

Throws

when the requested number of bytes cannot be read.

when the source is closed.

when startIndex or endIndex is out of range of sink array indices.

when startIndex > endIndex.

Samples

import kotlinx.io.*
+
fun Source.readTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size)(source)

Removes exactly endIndex - startIndex bytes from this source and copies them into sink subrange starting at startIndex and ending at endIndex.

Parameters

sink

the array to write data to

startIndex

the startIndex (inclusive) of the sink subrange to read data into, 0 by default.

endIndex

the endIndex (exclusive) of the sink subrange to read data into, sink.size by default.

Throws

when the requested number of bytes cannot be read.

when the source is closed.

when startIndex or endIndex is out of range of sink array indices.

when startIndex > endIndex.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -79,16 +79,13 @@ 

readTo

assertContentEquals(byteArrayOf(0, 1, 2, 3, 0, 0, 0, 0, 0, 0), out) assertContentEquals(byteArrayOf(4, 5, 6, 7), buffer.readByteArray()) //sampleEnd -}
fun Buffer.readTo(out: OutputStream, byteCount: Long = size)(source)

Consumes byteCount bytes from this buffer and writes it to out.

Parameters

out

the OutputStream to write to.

byteCount

the number of bytes to be written, Buffer.size by default.

Throws

when byteCount is negative or exceeds the buffer size.

Samples

import kotlinx.io.*
+}
fun Buffer.readTo(out: OutputStream, byteCount: Long = size)(source)

Consumes byteCount bytes from this buffer and writes it to out.

Parameters

out

the OutputStream to write to.

byteCount

the number of bytes to be written, Buffer.size by default.

Throws

when byteCount is negative or exceeds the buffer size.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-byte.html b/docs/kotlinx-io-core/kotlinx.io/read-u-byte.html
index 13d26d10..9c835b02 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-byte.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-byte.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readUByte

-

Removes an unsigned byte from this source and returns it.

Throws

when there are no more bytes to read.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes an unsigned byte from this source and returns it.

Throws

when there are no more bytes to read.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-int-le.html b/docs/kotlinx-io-core/kotlinx.io/read-u-int-le.html
index f91b32a4..62130b60 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-int-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-int-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readUIntLe

-

Removes four bytes from this source and returns an unsigned integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes four bytes from this source and returns an unsigned integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-int.html b/docs/kotlinx-io-core/kotlinx.io/read-u-int.html
index c77750ba..5b4deba8 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-int.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-int.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readUInt

-

Removes four bytes from this source and returns an unsigned integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes four bytes from this source and returns an unsigned integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an unsigned int value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-long-le.html b/docs/kotlinx-io-core/kotlinx.io/read-u-long-le.html
index 3e680ee4..adef5e9c 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-long-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-long-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readULongLe

-

Removes eight bytes from this source and returns an unsigned long integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an unsigned long value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes eight bytes from this source and returns an unsigned long integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an unsigned long value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-long.html b/docs/kotlinx-io-core/kotlinx.io/read-u-long.html
index e6444d3c..8f1954b5 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readULong

-

Removes eight bytes from this source and returns an unsigned long integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an unsigned long value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes eight bytes from this source and returns an unsigned long integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an unsigned long value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-short-le.html b/docs/kotlinx-io-core/kotlinx.io/read-u-short-le.html
index 100f924d..6850f850 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-short-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-short-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readUShortLe

-

Removes two bytes from this source and returns an unsigned short integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an unsigned short value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes two bytes from this source and returns an unsigned short integer composed of it according to the little-endian order.

Throws

when there are not enough data to read an unsigned short value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/read-u-short.html b/docs/kotlinx-io-core/kotlinx.io/read-u-short.html
index b55fd5d0..79455e35 100644
--- a/docs/kotlinx-io-core/kotlinx.io/read-u-short.html
+++ b/docs/kotlinx-io-core/kotlinx.io/read-u-short.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

readUShort

-

Removes two bytes from this source and returns an unsigned short integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an unsigned short value.

when the source is closed.

Samples

import kotlinx.io.*
+  

Removes two bytes from this source and returns an unsigned short integer composed of it according to the big-endian order.

Throws

when there are not enough data to read an unsigned short value.

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/snapshot.html b/docs/kotlinx-io-core/kotlinx.io/snapshot.html
index 8b544c0f..e1faf723 100644
--- a/docs/kotlinx-io-core/kotlinx.io/snapshot.html
+++ b/docs/kotlinx-io-core/kotlinx.io/snapshot.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

snapshot

-

Creates a byte string containing a copy of all the data from this buffer.

This call doesn't consume data from the buffer, but instead copies it.

+

Creates a byte string containing a copy of all the data from this buffer.

This call doesn't consume data from the buffer, but instead copies it.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

startsWith

-

Return true if the next byte to be consumed from this source is equal to byte. Otherwise, return false as well as when the source is exhausted.

If there is no buffered data, this call will result in a fetch from the underlying source.

Throws

when the source is closed.

Samples

import kotlinx.io.*
+  

Return true if the next byte to be consumed from this source is equal to byte. Otherwise, return false as well as when the source is exhausted.

If there is no buffered data, this call will result in a fetch from the underlying source.

Throws

when the source is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/transfer-from.html b/docs/kotlinx-io-core/kotlinx.io/transfer-from.html
index 4e17aa68..32085182 100644
--- a/docs/kotlinx-io-core/kotlinx.io/transfer-from.html
+++ b/docs/kotlinx-io-core/kotlinx.io/transfer-from.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -65,16 +65,13 @@

transferFrom

-

Read and exhaust bytes from input into this buffer. Stops reading data on input exhaustion.

Parameters

input

the stream to read data from.

Samples

import kotlinx.io.*
+

Reads and exhausts bytes from input into this buffer. Stops reading data on input exhaustion.

Parameters

input

the stream to read data from.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -91,16 +88,13 @@ 

transferFrom

assertEquals("hello", buffer.readString()) //sampleEnd -}

Reads all data from source into this buffer.

Samples

import kotlinx.io.*
+}

Reads all data from source into this buffer.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-code-point-value.html b/docs/kotlinx-io-core/kotlinx.io/write-code-point-value.html
index d3be2234..b7562f9a 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-code-point-value.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-code-point-value.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeCodePointValue

-

Encodes codePoint in UTF-8 and writes it to this sink.

codePoint should represent valid Unicode code point, meaning that its value should be within the Unicode codespace (U+000000 .. U+10ffff), otherwise IllegalArgumentException will be thrown.

Note that in general, a value retrieved from Char.code could not be written directly as it may be a part of a surrogate pair (that could be detected using Char.isSurrogate, or Char.isHighSurrogate and Char.isLowSurrogate). Such a pair of characters needs to be manually converted back to a single code point which then could be written to a Sink. Without such a conversion, data written to a Sink can not be converted back to a string from which a surrogate pair was retrieved.

More specifically, all code points mapping to UTF-16 surrogates (U+d800..U+dfff) will be written as ? characters (U+0063).

Parameters

codePoint

the codePoint to be written.

Throws

when the sink is closed.

when codePoint value is negative, or greater than U+10ffff.

Samples

import kotlinx.io.*
+  

Encodes codePoint in UTF-8 and writes it to this sink.

codePoint should represent valid Unicode code point, meaning that its value should be within the Unicode codespace (U+000000 .. U+10ffff), otherwise IllegalArgumentException will be thrown.

Note that in general, a value retrieved from Char.code could not be written directly as it may be a part of a surrogate pair (that could be detected using Char.isSurrogate, or Char.isHighSurrogate and Char.isLowSurrogate). Such a pair of characters needs to be manually converted back to a single code point which then could be written to a Sink. Without such a conversion, data written to a Sink can not be converted back to a string from which a surrogate pair was retrieved.

More specifically, all code points mapping to UTF-16 surrogates (U+d800..U+dfff) will be written as ? characters (U+0063).

Parameters

codePoint

the codePoint to be written.

Throws

when the sink is closed.

when codePoint value is negative, or greater than U+10ffff.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-decimal-long.html b/docs/kotlinx-io-core/kotlinx.io/write-decimal-long.html
index acf91910..603f1b3b 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-decimal-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-decimal-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeDecimalLong

-

Writes long to this sink in signed decimal form (i.e., as a string in base 10).

Resulting string will not contain leading zeros, except the 0 value itself.

Parameters

long

the long to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes long to this sink in signed decimal form (i.e., as a string in base 10).

Resulting string will not contain leading zeros, except the 0 value itself.

Parameters

long

the long to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-double-le.html b/docs/kotlinx-io-core/kotlinx.io/write-double-le.html
index becc3c14..849eab32 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-double-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-double-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeDoubleLe

-

Writes eight bytes of a bit representation of double, in the little-endian order, to this sink. Bit representation of the double corresponds to the IEEE 754 floating-point "double format" bit layout.

To obtain a bit representation, the Double.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Double.NaN may vary depending on a platform.

Parameters

double

the floating point number to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes eight bytes of a bit representation of double, in the little-endian order, to this sink. Bit representation of the double corresponds to the IEEE 754 floating-point "double format" bit layout.

To obtain a bit representation, the Double.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Double.NaN may vary depending on a platform.

Parameters

double

the floating point number to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-double.html b/docs/kotlinx-io-core/kotlinx.io/write-double.html
index bbe4f7bd..6a388835 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-double.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-double.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeDouble

-

Writes eight bytes of a bit representation of double, in the big-endian order, to this sink. Bit representation of the double corresponds to the IEEE 754 floating-point "double format" bit layout.

To obtain a bit representation, the Double.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Double.NaN may vary depending on a platform.

Parameters

double

the floating point number to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes eight bytes of a bit representation of double, in the big-endian order, to this sink. Bit representation of the double corresponds to the IEEE 754 floating-point "double format" bit layout.

To obtain a bit representation, the Double.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Double.NaN may vary depending on a platform.

Parameters

double

the floating point number to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-float-le.html b/docs/kotlinx-io-core/kotlinx.io/write-float-le.html
index fe636e17..4ae99b27 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-float-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-float-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeFloatLe

-

Writes four bytes of a bit representation of float, in the little-endian order, to this sink. Bit representation of the float corresponds to the IEEE 754 floating-point "single format" bit layout.

To obtain a bit representation, the Float.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Float.NaN may vary depending on a platform.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloatLe and then reading it back using Source.readFloatLe may not be equal to the original value. Please refer to Float.toBits documentation for details.

Parameters

float

the floating point number to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes four bytes of a bit representation of float, in the little-endian order, to this sink. Bit representation of the float corresponds to the IEEE 754 floating-point "single format" bit layout.

To obtain a bit representation, the Float.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Float.NaN may vary depending on a platform.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloatLe and then reading it back using Source.readFloatLe may not be equal to the original value. Please refer to Float.toBits documentation for details.

Parameters

float

the floating point number to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-float.html b/docs/kotlinx-io-core/kotlinx.io/write-float.html
index bdca41b9..844f9149 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-float.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-float.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeFloat

-

Writes four bytes of a bit representation of float, in the big-endian order, to this sink. Bit representation of the float corresponds to the IEEE 754 floating-point "single format" bit layout.

To obtain a bit representation, the Float.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Float.NaN may vary depending on a platform.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloat and then reading it back using Source.readFloat may not be equal to the original value. Please refer to Float.toBits documentation for details.

Parameters

float

the floating point number to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes four bytes of a bit representation of float, in the big-endian order, to this sink. Bit representation of the float corresponds to the IEEE 754 floating-point "single format" bit layout.

To obtain a bit representation, the Float.toBits function is used.

Should be used with care when working with special values (like NaN) as bit patterns obtained for Float.NaN may vary depending on a platform.

Note that in Kotlin/JS a value obtained by writing an original Float value to a Sink using Sink.writeFloat and then reading it back using Source.readFloat may not be equal to the original value. Please refer to Float.toBits documentation for details.

Parameters

float

the floating point number to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-hexadecimal-unsigned-long.html b/docs/kotlinx-io-core/kotlinx.io/write-hexadecimal-unsigned-long.html
index 3afbe23c..c9fd2afe 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-hexadecimal-unsigned-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-hexadecimal-unsigned-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeHexadecimalUnsignedLong

-

Writes long to this sink in hexadecimal form (i.e., as a string in base 16).

Resulting string will not contain leading zeros, except the 0 value itself.

Parameters

long

the long to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes long to this sink in hexadecimal form (i.e., as a string in base 16).

Resulting string will not contain leading zeros, except the 0 value itself.

Parameters

long

the long to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-int-le.html b/docs/kotlinx-io-core/kotlinx.io/write-int-le.html
index 5115cf79..0d58a0b7 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-int-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-int-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeIntLe

-

Writes four bytes containing int, in the little-endian order, to this sink.

Parameters

int

the integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes four bytes containing int, in the little-endian order, to this sink.

Parameters

int

the integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-long-le.html b/docs/kotlinx-io-core/kotlinx.io/write-long-le.html
index 5bf38049..50ba0840 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-long-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-long-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeLongLe

-

Writes eight bytes containing long, in the little-endian order, to this sink.

Parameters

long

the long integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes eight bytes containing long, in the little-endian order, to this sink.

Parameters

long

the long integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-short-le.html b/docs/kotlinx-io-core/kotlinx.io/write-short-le.html
index 42a53ee8..27c67c16 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-short-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-short-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeShortLe

-

Writes two bytes containing short, in the little-endian order, to this sink.

Parameters

short

the short integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes two bytes containing short, in the little-endian order, to this sink.

Parameters

short

the short integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-string.html b/docs/kotlinx-io-core/kotlinx.io/write-string.html
index ca72399c..097627f0 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-string.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-string.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -66,7 +66,7 @@

writeString

-
fun Sink.writeString(string: String, startIndex: Int = 0, endIndex: Int = string.length)(source)

Encodes the characters at startIndex up to endIndex from string in UTF-8 and writes it to this sink.

Parameters

string

the string to be encoded.

startIndex

the index (inclusive) of the first character to encode, 0 by default.

endIndex

the index (exclusive) of a character past to a last character to encode, string.length by default.

Throws

when startIndex or endIndex is out of range of string indices.

when startIndex > endIndex.

when the sink is closed.

Samples

import kotlinx.io.*
+
fun Sink.writeString(string: String, startIndex: Int = 0, endIndex: Int = string.length)(source)

Encodes the characters at startIndex up to endIndex from string in UTF-8 and writes it to this sink.

Parameters

string

the string to be encoded.

startIndex

the index (inclusive) of the first character to encode, 0 by default.

endIndex

the index (exclusive) of a character past to a last character to encode, string.length by default.

Throws

when startIndex or endIndex is out of range of string indices.

when startIndex > endIndex.

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -85,7 +85,7 @@ 

writeString

buffer.writeString("Δ") assertContentEquals(byteArrayOf(0xce.toByte(), 0x94.toByte()), buffer.readByteArray()) //sampleEnd -}

fun Sink.writeString(chars: CharSequence, startIndex: Int = 0, endIndex: Int = chars.length)(source)

Encodes the characters at startIndex up to endIndex from chars in UTF-8 and writes it to this sink.

Parameters

chars

the string to be encoded.

startIndex

the index (inclusive) of the first character to encode, 0 by default.

endIndex

the index (exclusive) of a character past to a last character to encode, chars.length by default.

Throws

when startIndex or endIndex is out of range of chars indices.

when startIndex > endIndex.

when the sink is closed.

Samples

import kotlinx.io.*
+}

fun Sink.writeString(chars: CharSequence, startIndex: Int = 0, endIndex: Int = chars.length)(source)

Encodes the characters at startIndex up to endIndex from chars in UTF-8 and writes it to this sink.

Parameters

chars

the string to be encoded.

startIndex

the index (inclusive) of the first character to encode, 0 by default.

endIndex

the index (exclusive) of a character past to a last character to encode, chars.length by default.

Throws

when startIndex or endIndex is out of range of chars indices.

when startIndex > endIndex.

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
@@ -104,16 +104,13 @@ 

writeString

buffer.writeString(StringBuilder("Δ")) assertContentEquals(byteArrayOf(0xce.toByte(), 0x94.toByte()), buffer.readByteArray()) //sampleEnd -}
fun Sink.writeString(string: String, charset: Charset, startIndex: Int = 0, endIndex: Int = string.length)(source)

Encodes substring of string starting at startIndex and ending at endIndex using charset and writes into this sink.

Parameters

string

the string to encode into this sink.

charset

the Charset to use for encoding.

startIndex

the index of the first character to encode, inclusive, 0 by default.

endIndex

the index of the last character to encode, exclusive, string.length by default.

Throws

when startIndex or endIndex is out of range of string indices.

when startIndex > endIndex.

when the sink is closed.

Samples

import kotlinx.io.*
+}
fun Sink.writeString(string: String, charset: Charset, startIndex: Int = 0, endIndex: Int = string.length)(source)

Encodes substring of string starting at startIndex and ending at endIndex using charset and writes into this sink.

Parameters

string

the string to encode into this sink.

charset

the Charset to use for encoding.

startIndex

the index of the first character to encode, inclusive, 0 by default.

endIndex

the index of the last character to encode, exclusive, string.length by default.

Throws

when startIndex or endIndex is out of range of string indices.

when startIndex > endIndex.

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-to-internal-buffer.html b/docs/kotlinx-io-core/kotlinx.io/write-to-internal-buffer.html
index 257f1091..7ea30b14 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-to-internal-buffer.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-to-internal-buffer.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeToInternalBuffer

-

Provides direct access to the sink's internal buffer and hints its emit before exit.

The internal buffer is passed into lambda, and it may be partially emitted to the underlying sink before returning from this method.

Use this method with care as the data within the buffer is not yet emitted to the underlying sink and consumption of data from the buffer will cause its loss.

Parameters

lambda

the callback accessing internal buffer.

Throws

when the sink is closed.

+

Provides direct access to the sink's internal buffer and hints its emit before exit.

The internal buffer is passed into lambda, and it may be partially emitted to the underlying sink before returning from this method.

Use this method with care as the data within the buffer is not yet emitted to the underlying sink and consumption of data from the buffer will cause its loss.

Parameters

lambda

the callback accessing internal buffer.

Throws

when the sink is closed.

when some I/O error occurs.

-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeUByte

-

Writes am unsigned byte to this sink.

Parameters

byte

the byte to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes am unsigned byte to this sink.

Parameters

byte

the byte to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-u-int-le.html b/docs/kotlinx-io-core/kotlinx.io/write-u-int-le.html
index da99ea01..44666e49 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-u-int-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-u-int-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeUIntLe

-

Writes four bytes containing int, in the little-endian order, to this sink.

Parameters

int

the unsigned integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes four bytes containing int, in the little-endian order, to this sink.

Parameters

int

the unsigned integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-u-int.html b/docs/kotlinx-io-core/kotlinx.io/write-u-int.html
index 495189e7..b9489e89 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-u-int.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-u-int.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeUInt

-

Writes four bytes containing int, in the big-endian order, to this sink.

Parameters

int

the unsigned integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes four bytes containing int, in the big-endian order, to this sink.

Parameters

int

the unsigned integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-u-long-le.html b/docs/kotlinx-io-core/kotlinx.io/write-u-long-le.html
index c7a529c4..f90a53f9 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-u-long-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-u-long-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeULongLe

-

Writes eight bytes containing long, in the little-endian order, to this sink.

Parameters

long

the unsigned long integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes eight bytes containing long, in the little-endian order, to this sink.

Parameters

long

the unsigned long integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-u-long.html b/docs/kotlinx-io-core/kotlinx.io/write-u-long.html
index f7f09e81..452a40d8 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-u-long.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-u-long.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeULong

-

Writes eight bytes containing long, in the big-endian order, to this sink.

Parameters

long

the unsigned long integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes eight bytes containing long, in the big-endian order, to this sink.

Parameters

long

the unsigned long integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-u-short-le.html b/docs/kotlinx-io-core/kotlinx.io/write-u-short-le.html
index f14ef20e..53c1f63f 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-u-short-le.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-u-short-le.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeUShortLe

-

Writes two bytes containing short, in the little-endian order, to this sink.

Parameters

short

the unsigned short integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes two bytes containing short, in the little-endian order, to this sink.

Parameters

short

the unsigned short integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write-u-short.html b/docs/kotlinx-io-core/kotlinx.io/write-u-short.html
index 322d874d..64131db1 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write-u-short.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write-u-short.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -63,7 +63,7 @@

writeUShort

-

Writes two bytes containing short, in the big-endian order, to this sink.

Parameters

short

the unsigned short integer to be written.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+  

Writes two bytes containing short, in the big-endian order, to this sink.

Parameters

short

the unsigned short integer to be written.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlin.test.*
 
 fun main() { 
diff --git a/docs/kotlinx-io-core/kotlinx.io/write.html b/docs/kotlinx-io-core/kotlinx.io/write.html
index 2f772278..02bae955 100644
--- a/docs/kotlinx-io-core/kotlinx.io/write.html
+++ b/docs/kotlinx-io-core/kotlinx.io/write.html
@@ -41,7 +41,7 @@
 
                             kotlinx-io
                                 
-
0.5.3 +
0.5.4
@@ -66,12 +66,10 @@

write

-
fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)(source)

Writes subsequence of data from byteString starting at startIndex and ending at endIndex into a sink.

Parameters

byteString

the byte string whose subsequence should be written to a sink.

startIndex

the first index (inclusive) to copy data from the byteString.

endIndex

the last index (exclusive) to copy data from the byteString

Throws

when startIndex or endIndex is out of range of byteString indices.

when startIndex > endIndex.

if the sink is closed.

Samples

import kotlinx.io.*
+
fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)(source)

Writes subsequence of data from byteString starting at startIndex and ending at endIndex into a sink.

Parameters

byteString

the byte string whose subsequence should be written to a sink.

startIndex

the first index (inclusive) to copy data from the byteString.

endIndex

the last index (exclusive) to copy data from the byteString

Throws

when startIndex or endIndex is out of range of byteString indices.

when startIndex > endIndex.

if the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import kotlinx.io.bytestring.ByteString
 import kotlinx.io.bytestring.encodeToByteString
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -80,16 +78,13 @@ 

write

buffer.write(ByteString(1, 2, 3, 4)) assertEquals(4, buffer.size) //sampleEnd -}
fun Buffer.write(input: InputStream, byteCount: Long): Buffer(source)

Read byteCount bytes from input into this buffer. Throws an exception when input is exhausted before reading byteCount bytes.

Parameters

input

the stream to read data from.

byteCount

the number of bytes read from input.

Throws

when input exhausted before reading byteCount bytes from it.

Samples

import kotlinx.io.*
+}
fun Buffer.write(input: InputStream, byteCount: Long): Buffer(source)

Reads byteCount bytes from input into this buffer. Throws an exception when input is exhausted before reading byteCount bytes.

Parameters

input

the stream to read data from.

byteCount

the number of bytes read from input.

Throws

when input exhausted before reading byteCount bytes from it.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
@@ -99,16 +94,13 @@ 

write

buffer.write(inputStream, 5) assertEquals("hello", buffer.readString()) //sampleEnd -}

fun Sink.write(source: ByteBuffer): Int(source)

Writes data from the source into this sink and returns the number of bytes written.

Parameters

source

the source to read from.

Throws

when the sink is closed.

Samples

import kotlinx.io.*
+}

fun Sink.write(source: ByteBuffer): Int(source)

Writes data from the source into this sink and returns the number of bytes written.

Parameters

source

the source to read from.

Throws

when the sink is closed.

when some I/O error occurs.

Samples

import kotlinx.io.*
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.util.zip.GZIPInputStream
 import java.util.zip.GZIPOutputStream
-import kotlin.test.Test
-import kotlin.test.assertContentEquals
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 fun main() { 
    //sampleStart 
diff --git a/docs/kotlinx-io-core/navigation.html b/docs/kotlinx-io-core/navigation.html
index ccb42c9d..5ad33a39 100644
--- a/docs/kotlinx-io-core/navigation.html
+++ b/docs/kotlinx-io-core/navigation.html
@@ -1,9 +1,9 @@
 
-
+
-
+
@@ -12,126 +12,151 @@ append()
-
+ + -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
+ +
+ -
+ -
+ -
+ -
+ -
+ -
diff --git a/docs/navigation.html b/docs/navigation.html index 7e912421..196f1583 100644 --- a/docs/navigation.html +++ b/docs/navigation.html @@ -1,9 +1,9 @@
-
+
-
+
@@ -12,126 +12,151 @@ append()
-
+ + -
+
- -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+
+ +
+ -
+ -
+ -
+ -
+ -
+ -
diff --git a/docs/scripts/pages.json b/docs/scripts/pages.json index e7d4fb2c..cdea0457 100644 --- a/docs/scripts/pages.json +++ b/docs/scripts/pages.json @@ -1 +1 @@ -[{"name":"class ByteString : Comparable ","description":"kotlinx.io.bytestring.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/index.html","searchKeys":["ByteString","class ByteString : Comparable ","kotlinx.io.bytestring.ByteString"]},{"name":"class ByteStringBuilder(initialCapacity: Int = 0)","description":"kotlinx.io.bytestring.ByteStringBuilder","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html","searchKeys":["ByteStringBuilder","class ByteStringBuilder(initialCapacity: Int = 0)","kotlinx.io.bytestring.ByteStringBuilder"]},{"name":"constructor(data: ByteArray, startIndex: Int = 0, endIndex: Int = data.size)","description":"kotlinx.io.bytestring.ByteString.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-byte-string.html","searchKeys":["ByteString","constructor(data: ByteArray, startIndex: Int = 0, endIndex: Int = data.size)","kotlinx.io.bytestring.ByteString.ByteString"]},{"name":"constructor(initialCapacity: Int = 0)","description":"kotlinx.io.bytestring.ByteStringBuilder.ByteStringBuilder","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html","searchKeys":["ByteStringBuilder","constructor(initialCapacity: Int = 0)","kotlinx.io.bytestring.ByteStringBuilder.ByteStringBuilder"]},{"name":"fun Base64.encodeToAppendable(source: ByteString, destination: A, startIndex: Int = 0, endIndex: Int = source.size): A","description":"kotlinx.io.bytestring.encodeToAppendable","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-appendable.html","searchKeys":["encodeToAppendable","fun Base64.encodeToAppendable(source: ByteString, destination: A, startIndex: Int = 0, endIndex: Int = source.size): A","kotlinx.io.bytestring.encodeToAppendable"]},{"name":"fun Base64.decode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","description":"kotlinx.io.bytestring.decode","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode.html","searchKeys":["decode","fun Base64.decode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","kotlinx.io.bytestring.decode"]},{"name":"fun Base64.decodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","description":"kotlinx.io.bytestring.decodeIntoByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-into-byte-array.html","searchKeys":["decodeIntoByteArray","fun Base64.decodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","kotlinx.io.bytestring.decodeIntoByteArray"]},{"name":"fun Base64.decodeToByteString(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): ByteString","description":"kotlinx.io.bytestring.decodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html","searchKeys":["decodeToByteString","fun Base64.decodeToByteString(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): ByteString","kotlinx.io.bytestring.decodeToByteString"]},{"name":"fun Base64.decodeToByteString(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteString","description":"kotlinx.io.bytestring.decodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html","searchKeys":["decodeToByteString","fun Base64.decodeToByteString(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteString","kotlinx.io.bytestring.decodeToByteString"]},{"name":"fun Base64.decodeToByteString(source: CharSequence, startIndex: Int = 0, endIndex: Int = source.length): ByteString","description":"kotlinx.io.bytestring.decodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html","searchKeys":["decodeToByteString","fun Base64.decodeToByteString(source: CharSequence, startIndex: Int = 0, endIndex: Int = source.length): ByteString","kotlinx.io.bytestring.decodeToByteString"]},{"name":"fun Base64.encode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): String","description":"kotlinx.io.bytestring.encode","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode.html","searchKeys":["encode","fun Base64.encode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): String","kotlinx.io.bytestring.encode"]},{"name":"fun Base64.encodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","description":"kotlinx.io.bytestring.encodeIntoByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-into-byte-array.html","searchKeys":["encodeIntoByteArray","fun Base64.encodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","kotlinx.io.bytestring.encodeIntoByteArray"]},{"name":"fun Base64.encodeToByteArray(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","description":"kotlinx.io.bytestring.encodeToByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-array.html","searchKeys":["encodeToByteArray","fun Base64.encodeToByteArray(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","kotlinx.io.bytestring.encodeToByteArray"]},{"name":"fun ByteString(vararg bytes: Byte): ByteString","description":"kotlinx.io.bytestring.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html","searchKeys":["ByteString","fun ByteString(vararg bytes: Byte): ByteString","kotlinx.io.bytestring.ByteString"]},{"name":"fun ByteString.contentEquals(array: ByteArray): Boolean","description":"kotlinx.io.bytestring.contentEquals","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/content-equals.html","searchKeys":["contentEquals","fun ByteString.contentEquals(array: ByteArray): Boolean","kotlinx.io.bytestring.contentEquals"]},{"name":"fun ByteString.decodeToString(): String","description":"kotlinx.io.bytestring.decodeToString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html","searchKeys":["decodeToString","fun ByteString.decodeToString(): String","kotlinx.io.bytestring.decodeToString"]},{"name":"fun ByteString.decodeToString(charset: Charset): String","description":"kotlinx.io.bytestring.decodeToString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html","searchKeys":["decodeToString","fun ByteString.decodeToString(charset: Charset): String","kotlinx.io.bytestring.decodeToString"]},{"name":"fun ByteString.endsWith(byteArray: ByteArray): Boolean","description":"kotlinx.io.bytestring.endsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html","searchKeys":["endsWith","fun ByteString.endsWith(byteArray: ByteArray): Boolean","kotlinx.io.bytestring.endsWith"]},{"name":"fun ByteString.endsWith(byteString: ByteString): Boolean","description":"kotlinx.io.bytestring.endsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html","searchKeys":["endsWith","fun ByteString.endsWith(byteString: ByteString): Boolean","kotlinx.io.bytestring.endsWith"]},{"name":"fun ByteString.indexOf(byte: Byte, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.indexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html","searchKeys":["indexOf","fun ByteString.indexOf(byte: Byte, startIndex: Int = 0): Int","kotlinx.io.bytestring.indexOf"]},{"name":"fun ByteString.indexOf(byteArray: ByteArray, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.indexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html","searchKeys":["indexOf","fun ByteString.indexOf(byteArray: ByteArray, startIndex: Int = 0): Int","kotlinx.io.bytestring.indexOf"]},{"name":"fun ByteString.indexOf(byteString: ByteString, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.indexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html","searchKeys":["indexOf","fun ByteString.indexOf(byteString: ByteString, startIndex: Int = 0): Int","kotlinx.io.bytestring.indexOf"]},{"name":"fun ByteString.isEmpty(): Boolean","description":"kotlinx.io.bytestring.isEmpty","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/is-empty.html","searchKeys":["isEmpty","fun ByteString.isEmpty(): Boolean","kotlinx.io.bytestring.isEmpty"]},{"name":"fun ByteString.isNotEmpty(): Boolean","description":"kotlinx.io.bytestring.isNotEmpty","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/is-not-empty.html","searchKeys":["isNotEmpty","fun ByteString.isNotEmpty(): Boolean","kotlinx.io.bytestring.isNotEmpty"]},{"name":"fun ByteString.lastIndexOf(byte: Byte, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.lastIndexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/last-index-of.html","searchKeys":["lastIndexOf","fun ByteString.lastIndexOf(byte: Byte, startIndex: Int = 0): Int","kotlinx.io.bytestring.lastIndexOf"]},{"name":"fun ByteString.lastIndexOf(byteArray: ByteArray, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.lastIndexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/last-index-of.html","searchKeys":["lastIndexOf","fun ByteString.lastIndexOf(byteArray: ByteArray, startIndex: Int = 0): Int","kotlinx.io.bytestring.lastIndexOf"]},{"name":"fun ByteString.lastIndexOf(byteString: ByteString, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.lastIndexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/last-index-of.html","searchKeys":["lastIndexOf","fun ByteString.lastIndexOf(byteString: ByteString, startIndex: Int = 0): Int","kotlinx.io.bytestring.lastIndexOf"]},{"name":"fun ByteString.startsWith(byteArray: ByteArray): Boolean","description":"kotlinx.io.bytestring.startsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html","searchKeys":["startsWith","fun ByteString.startsWith(byteArray: ByteArray): Boolean","kotlinx.io.bytestring.startsWith"]},{"name":"fun ByteString.startsWith(byteString: ByteString): Boolean","description":"kotlinx.io.bytestring.startsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html","searchKeys":["startsWith","fun ByteString.startsWith(byteString: ByteString): Boolean","kotlinx.io.bytestring.startsWith"]},{"name":"fun ByteString.toHexString(format: HexFormat = HexFormat.Default): String","description":"kotlinx.io.bytestring.toHexString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html","searchKeys":["toHexString","fun ByteString.toHexString(format: HexFormat = HexFormat.Default): String","kotlinx.io.bytestring.toHexString"]},{"name":"fun ByteString.toHexString(startIndex: Int = 0, endIndex: Int = size, format: HexFormat = HexFormat.Default): String","description":"kotlinx.io.bytestring.toHexString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html","searchKeys":["toHexString","fun ByteString.toHexString(startIndex: Int = 0, endIndex: Int = size, format: HexFormat = HexFormat.Default): String","kotlinx.io.bytestring.toHexString"]},{"name":"fun ByteStringBuilder.append(byte: UByte)","description":"kotlinx.io.bytestring.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/append.html","searchKeys":["append","fun ByteStringBuilder.append(byte: UByte)","kotlinx.io.bytestring.append"]},{"name":"fun ByteStringBuilder.append(byteString: ByteString)","description":"kotlinx.io.bytestring.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/append.html","searchKeys":["append","fun ByteStringBuilder.append(byteString: ByteString)","kotlinx.io.bytestring.append"]},{"name":"fun ByteStringBuilder.append(vararg bytes: Byte)","description":"kotlinx.io.bytestring.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/append.html","searchKeys":["append","fun ByteStringBuilder.append(vararg bytes: Byte)","kotlinx.io.bytestring.append"]},{"name":"fun String.encodeToByteString(): ByteString","description":"kotlinx.io.bytestring.encodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html","searchKeys":["encodeToByteString","fun String.encodeToByteString(): ByteString","kotlinx.io.bytestring.encodeToByteString"]},{"name":"fun String.encodeToByteString(charset: Charset): ByteString","description":"kotlinx.io.bytestring.encodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html","searchKeys":["encodeToByteString","fun String.encodeToByteString(charset: Charset): ByteString","kotlinx.io.bytestring.encodeToByteString"]},{"name":"fun String.hexToByteString(format: HexFormat = HexFormat.Default): ByteString","description":"kotlinx.io.bytestring.hexToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/hex-to-byte-string.html","searchKeys":["hexToByteString","fun String.hexToByteString(format: HexFormat = HexFormat.Default): ByteString","kotlinx.io.bytestring.hexToByteString"]},{"name":"fun append(array: ByteArray, startIndex: Int = 0, endIndex: Int = array.size)","description":"kotlinx.io.bytestring.ByteStringBuilder.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html","searchKeys":["append","fun append(array: ByteArray, startIndex: Int = 0, endIndex: Int = array.size)","kotlinx.io.bytestring.ByteStringBuilder.append"]},{"name":"fun append(byte: Byte)","description":"kotlinx.io.bytestring.ByteStringBuilder.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html","searchKeys":["append","fun append(byte: Byte)","kotlinx.io.bytestring.ByteStringBuilder.append"]},{"name":"fun copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size)","description":"kotlinx.io.bytestring.ByteString.copyInto","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/copy-into.html","searchKeys":["copyInto","fun copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size)","kotlinx.io.bytestring.ByteString.copyInto"]},{"name":"fun substring(startIndex: Int, endIndex: Int = size): ByteString","description":"kotlinx.io.bytestring.ByteString.substring","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/substring.html","searchKeys":["substring","fun substring(startIndex: Int, endIndex: Int = size): ByteString","kotlinx.io.bytestring.ByteString.substring"]},{"name":"fun toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray","description":"kotlinx.io.bytestring.ByteString.toByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-byte-array.html","searchKeys":["toByteArray","fun toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray","kotlinx.io.bytestring.ByteString.toByteArray"]},{"name":"fun toByteString(): ByteString","description":"kotlinx.io.bytestring.ByteStringBuilder.toByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html","searchKeys":["toByteString","fun toByteString(): ByteString","kotlinx.io.bytestring.ByteStringBuilder.toByteString"]},{"name":"inline fun buildByteString(capacity: Int = 0, builderAction: ByteStringBuilder.() -> Unit): ByteString","description":"kotlinx.io.bytestring.buildByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/build-byte-string.html","searchKeys":["buildByteString","inline fun buildByteString(capacity: Int = 0, builderAction: ByteStringBuilder.() -> Unit): ByteString","kotlinx.io.bytestring.buildByteString"]},{"name":"object Companion","description":"kotlinx.io.bytestring.ByteString.Companion","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-companion/index.html","searchKeys":["Companion","object Companion","kotlinx.io.bytestring.ByteString.Companion"]},{"name":"open operator override fun compareTo(other: ByteString): Int","description":"kotlinx.io.bytestring.ByteString.compareTo","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/compare-to.html","searchKeys":["compareTo","open operator override fun compareTo(other: ByteString): Int","kotlinx.io.bytestring.ByteString.compareTo"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"kotlinx.io.bytestring.ByteString.equals","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","kotlinx.io.bytestring.ByteString.equals"]},{"name":"open override fun hashCode(): Int","description":"kotlinx.io.bytestring.ByteString.hashCode","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","kotlinx.io.bytestring.ByteString.hashCode"]},{"name":"open override fun toString(): String","description":"kotlinx.io.bytestring.ByteString.toString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-string.html","searchKeys":["toString","open override fun toString(): String","kotlinx.io.bytestring.ByteString.toString"]},{"name":"operator fun get(index: Int): Byte","description":"kotlinx.io.bytestring.ByteString.get","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/get.html","searchKeys":["get","operator fun get(index: Int): Byte","kotlinx.io.bytestring.ByteString.get"]},{"name":"val ByteString.indices: IntRange","description":"kotlinx.io.bytestring.indices","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/indices.html","searchKeys":["indices","val ByteString.indices: IntRange","kotlinx.io.bytestring.indices"]},{"name":"val capacity: Int","description":"kotlinx.io.bytestring.ByteStringBuilder.capacity","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html","searchKeys":["capacity","val capacity: Int","kotlinx.io.bytestring.ByteStringBuilder.capacity"]},{"name":"val size: Int","description":"kotlinx.io.bytestring.ByteString.size","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/size.html","searchKeys":["size","val size: Int","kotlinx.io.bytestring.ByteString.size"]},{"name":"val size: Int","description":"kotlinx.io.bytestring.ByteStringBuilder.size","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html","searchKeys":["size","val size: Int","kotlinx.io.bytestring.ByteStringBuilder.size"]},{"name":"abstract fun atomicMove(source: Path, destination: Path)","description":"kotlinx.io.files.FileSystem.atomicMove","location":"kotlinx-io-core/kotlinx.io.files/-file-system/atomic-move.html","searchKeys":["atomicMove","abstract fun atomicMove(source: Path, destination: Path)","kotlinx.io.files.FileSystem.atomicMove"]},{"name":"abstract fun createDirectories(path: Path, mustCreate: Boolean = false)","description":"kotlinx.io.files.FileSystem.createDirectories","location":"kotlinx-io-core/kotlinx.io.files/-file-system/create-directories.html","searchKeys":["createDirectories","abstract fun createDirectories(path: Path, mustCreate: Boolean = false)","kotlinx.io.files.FileSystem.createDirectories"]},{"name":"abstract fun delete(path: Path, mustExist: Boolean = true)","description":"kotlinx.io.files.FileSystem.delete","location":"kotlinx-io-core/kotlinx.io.files/-file-system/delete.html","searchKeys":["delete","abstract fun delete(path: Path, mustExist: Boolean = true)","kotlinx.io.files.FileSystem.delete"]},{"name":"abstract fun emit()","description":"kotlinx.io.Sink.emit","location":"kotlinx-io-core/kotlinx.io/-sink/emit.html","searchKeys":["emit","abstract fun emit()","kotlinx.io.Sink.emit"]},{"name":"abstract fun exhausted(): Boolean","description":"kotlinx.io.Source.exhausted","location":"kotlinx-io-core/kotlinx.io/-source/exhausted.html","searchKeys":["exhausted","abstract fun exhausted(): Boolean","kotlinx.io.Source.exhausted"]},{"name":"abstract fun exists(path: Path): Boolean","description":"kotlinx.io.files.FileSystem.exists","location":"kotlinx-io-core/kotlinx.io.files/-file-system/exists.html","searchKeys":["exists","abstract fun exists(path: Path): Boolean","kotlinx.io.files.FileSystem.exists"]},{"name":"abstract fun hintEmit()","description":"kotlinx.io.Sink.hintEmit","location":"kotlinx-io-core/kotlinx.io/-sink/hint-emit.html","searchKeys":["hintEmit","abstract fun hintEmit()","kotlinx.io.Sink.hintEmit"]},{"name":"abstract fun list(directory: Path): Collection","description":"kotlinx.io.files.FileSystem.list","location":"kotlinx-io-core/kotlinx.io.files/-file-system/list.html","searchKeys":["list","abstract fun list(directory: Path): Collection","kotlinx.io.files.FileSystem.list"]},{"name":"abstract fun metadataOrNull(path: Path): FileMetadata?","description":"kotlinx.io.files.FileSystem.metadataOrNull","location":"kotlinx-io-core/kotlinx.io.files/-file-system/metadata-or-null.html","searchKeys":["metadataOrNull","abstract fun metadataOrNull(path: Path): FileMetadata?","kotlinx.io.files.FileSystem.metadataOrNull"]},{"name":"abstract fun peek(): Source","description":"kotlinx.io.Source.peek","location":"kotlinx-io-core/kotlinx.io/-source/peek.html","searchKeys":["peek","abstract fun peek(): Source","kotlinx.io.Source.peek"]},{"name":"abstract fun readAtMostTo(sink: Buffer, byteCount: Long): Long","description":"kotlinx.io.RawSource.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-raw-source/read-at-most-to.html","searchKeys":["readAtMostTo","abstract fun readAtMostTo(sink: Buffer, byteCount: Long): Long","kotlinx.io.RawSource.readAtMostTo"]},{"name":"abstract fun readAtMostTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size): Int","description":"kotlinx.io.Source.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-source/read-at-most-to.html","searchKeys":["readAtMostTo","abstract fun readAtMostTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size): Int","kotlinx.io.Source.readAtMostTo"]},{"name":"abstract fun readByte(): Byte","description":"kotlinx.io.Source.readByte","location":"kotlinx-io-core/kotlinx.io/-source/read-byte.html","searchKeys":["readByte","abstract fun readByte(): Byte","kotlinx.io.Source.readByte"]},{"name":"abstract fun readInt(): Int","description":"kotlinx.io.Source.readInt","location":"kotlinx-io-core/kotlinx.io/-source/read-int.html","searchKeys":["readInt","abstract fun readInt(): Int","kotlinx.io.Source.readInt"]},{"name":"abstract fun readLong(): Long","description":"kotlinx.io.Source.readLong","location":"kotlinx-io-core/kotlinx.io/-source/read-long.html","searchKeys":["readLong","abstract fun readLong(): Long","kotlinx.io.Source.readLong"]},{"name":"abstract fun readShort(): Short","description":"kotlinx.io.Source.readShort","location":"kotlinx-io-core/kotlinx.io/-source/read-short.html","searchKeys":["readShort","abstract fun readShort(): Short","kotlinx.io.Source.readShort"]},{"name":"abstract fun readTo(sink: RawSink, byteCount: Long)","description":"kotlinx.io.Source.readTo","location":"kotlinx-io-core/kotlinx.io/-source/read-to.html","searchKeys":["readTo","abstract fun readTo(sink: RawSink, byteCount: Long)","kotlinx.io.Source.readTo"]},{"name":"abstract fun request(byteCount: Long): Boolean","description":"kotlinx.io.Source.request","location":"kotlinx-io-core/kotlinx.io/-source/request.html","searchKeys":["request","abstract fun request(byteCount: Long): Boolean","kotlinx.io.Source.request"]},{"name":"abstract fun require(byteCount: Long)","description":"kotlinx.io.Source.require","location":"kotlinx-io-core/kotlinx.io/-source/require.html","searchKeys":["require","abstract fun require(byteCount: Long)","kotlinx.io.Source.require"]},{"name":"abstract fun resolve(path: Path): Path","description":"kotlinx.io.files.FileSystem.resolve","location":"kotlinx-io-core/kotlinx.io.files/-file-system/resolve.html","searchKeys":["resolve","abstract fun resolve(path: Path): Path","kotlinx.io.files.FileSystem.resolve"]},{"name":"abstract fun sink(path: Path, append: Boolean = false): RawSink","description":"kotlinx.io.files.FileSystem.sink","location":"kotlinx-io-core/kotlinx.io.files/-file-system/sink.html","searchKeys":["sink","abstract fun sink(path: Path, append: Boolean = false): RawSink","kotlinx.io.files.FileSystem.sink"]},{"name":"abstract fun skip(byteCount: Long)","description":"kotlinx.io.Source.skip","location":"kotlinx-io-core/kotlinx.io/-source/skip.html","searchKeys":["skip","abstract fun skip(byteCount: Long)","kotlinx.io.Source.skip"]},{"name":"abstract fun source(path: Path): RawSource","description":"kotlinx.io.files.FileSystem.source","location":"kotlinx-io-core/kotlinx.io.files/-file-system/source.html","searchKeys":["source","abstract fun source(path: Path): RawSource","kotlinx.io.files.FileSystem.source"]},{"name":"abstract fun transferFrom(source: RawSource): Long","description":"kotlinx.io.Sink.transferFrom","location":"kotlinx-io-core/kotlinx.io/-sink/transfer-from.html","searchKeys":["transferFrom","abstract fun transferFrom(source: RawSource): Long","kotlinx.io.Sink.transferFrom"]},{"name":"abstract fun transferTo(sink: RawSink): Long","description":"kotlinx.io.Source.transferTo","location":"kotlinx-io-core/kotlinx.io/-source/transfer-to.html","searchKeys":["transferTo","abstract fun transferTo(sink: RawSink): Long","kotlinx.io.Source.transferTo"]},{"name":"abstract fun write(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size)","description":"kotlinx.io.Sink.write","location":"kotlinx-io-core/kotlinx.io/-sink/write.html","searchKeys":["write","abstract fun write(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size)","kotlinx.io.Sink.write"]},{"name":"abstract fun write(source: RawSource, byteCount: Long)","description":"kotlinx.io.Sink.write","location":"kotlinx-io-core/kotlinx.io/-sink/write.html","searchKeys":["write","abstract fun write(source: RawSource, byteCount: Long)","kotlinx.io.Sink.write"]},{"name":"abstract fun writeByte(byte: Byte)","description":"kotlinx.io.Sink.writeByte","location":"kotlinx-io-core/kotlinx.io/-sink/write-byte.html","searchKeys":["writeByte","abstract fun writeByte(byte: Byte)","kotlinx.io.Sink.writeByte"]},{"name":"abstract fun writeInt(int: Int)","description":"kotlinx.io.Sink.writeInt","location":"kotlinx-io-core/kotlinx.io/-sink/write-int.html","searchKeys":["writeInt","abstract fun writeInt(int: Int)","kotlinx.io.Sink.writeInt"]},{"name":"abstract fun writeLong(long: Long)","description":"kotlinx.io.Sink.writeLong","location":"kotlinx-io-core/kotlinx.io/-sink/write-long.html","searchKeys":["writeLong","abstract fun writeLong(long: Long)","kotlinx.io.Sink.writeLong"]},{"name":"abstract fun writeShort(short: Short)","description":"kotlinx.io.Sink.writeShort","location":"kotlinx-io-core/kotlinx.io/-sink/write-short.html","searchKeys":["writeShort","abstract fun writeShort(short: Short)","kotlinx.io.Sink.writeShort"]},{"name":"abstract override fun close()","description":"kotlinx.io.RawSource.close","location":"kotlinx-io-core/kotlinx.io/-raw-source/close.html","searchKeys":["close","abstract override fun close()","kotlinx.io.RawSource.close"]},{"name":"abstract override fun flush()","description":"kotlinx.io.Sink.flush","location":"kotlinx-io-core/kotlinx.io/-sink/flush.html","searchKeys":["flush","abstract override fun flush()","kotlinx.io.Sink.flush"]},{"name":"abstract val buffer: Buffer","description":"kotlinx.io.Sink.buffer","location":"kotlinx-io-core/kotlinx.io/-sink/buffer.html","searchKeys":["buffer","abstract val buffer: Buffer","kotlinx.io.Sink.buffer"]},{"name":"abstract val buffer: Buffer","description":"kotlinx.io.Source.buffer","location":"kotlinx-io-core/kotlinx.io/-source/buffer.html","searchKeys":["buffer","abstract val buffer: Buffer","kotlinx.io.Source.buffer"]},{"name":"annotation class DelicateIoApi","description":"kotlinx.io.DelicateIoApi","location":"kotlinx-io-core/kotlinx.io/-delicate-io-api/index.html","searchKeys":["DelicateIoApi","annotation class DelicateIoApi","kotlinx.io.DelicateIoApi"]},{"name":"annotation class InternalIoApi","description":"kotlinx.io.InternalIoApi","location":"kotlinx-io-core/kotlinx.io/-internal-io-api/index.html","searchKeys":["InternalIoApi","annotation class InternalIoApi","kotlinx.io.InternalIoApi"]},{"name":"annotation class UnsafeIoApi","description":"kotlinx.io.UnsafeIoApi","location":"kotlinx-io-core/kotlinx.io/-unsafe-io-api/index.html","searchKeys":["UnsafeIoApi","annotation class UnsafeIoApi","kotlinx.io.UnsafeIoApi"]},{"name":"class Buffer : Source, Sink","description":"kotlinx.io.Buffer","location":"kotlinx-io-core/kotlinx.io/-buffer/index.html","searchKeys":["Buffer","class Buffer : Source, Sink","kotlinx.io.Buffer"]},{"name":"class FileMetadata(val isRegularFile: Boolean = false, val isDirectory: Boolean = false, val size: Long = 0)","description":"kotlinx.io.files.FileMetadata","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/index.html","searchKeys":["FileMetadata","class FileMetadata(val isRegularFile: Boolean = false, val isDirectory: Boolean = false, val size: Long = 0)","kotlinx.io.files.FileMetadata"]},{"name":"class Segment","description":"kotlinx.io.Segment","location":"kotlinx-io-core/kotlinx.io/-segment/index.html","searchKeys":["Segment","class Segment","kotlinx.io.Segment"]},{"name":"constructor()","description":"kotlinx.io.Buffer.Buffer","location":"kotlinx-io-core/kotlinx.io/-buffer/-buffer.html","searchKeys":["Buffer","constructor()","kotlinx.io.Buffer.Buffer"]},{"name":"constructor(isRegularFile: Boolean = false, isDirectory: Boolean = false, size: Long = 0)","description":"kotlinx.io.files.FileMetadata.FileMetadata","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/-file-metadata.html","searchKeys":["FileMetadata","constructor(isRegularFile: Boolean = false, isDirectory: Boolean = false, size: Long = 0)","kotlinx.io.files.FileMetadata.FileMetadata"]},{"name":"expect abstract fun flush()","description":"kotlinx.io.RawSink.flush","location":"kotlinx-io-core/kotlinx.io/-raw-sink/flush.html","searchKeys":["flush","expect abstract fun flush()","kotlinx.io.RawSink.flush"]},{"name":"expect abstract fun write(source: Buffer, byteCount: Long)","description":"kotlinx.io.RawSink.write","location":"kotlinx-io-core/kotlinx.io/-raw-sink/write.html","searchKeys":["write","expect abstract fun write(source: Buffer, byteCount: Long)","kotlinx.io.RawSink.write"]},{"name":"expect abstract override fun close()","description":"kotlinx.io.RawSink.close","location":"kotlinx-io-core/kotlinx.io/-raw-sink/close.html","searchKeys":["close","expect abstract override fun close()","kotlinx.io.RawSink.close"]},{"name":"expect class FileNotFoundException(message: String?) : IOException","description":"kotlinx.io.files.FileNotFoundException","location":"kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/index.html","searchKeys":["FileNotFoundException","expect class FileNotFoundException(message: String?) : IOException","kotlinx.io.files.FileNotFoundException"]},{"name":"expect class Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path/index.html","searchKeys":["Path","expect class Path","kotlinx.io.files.Path"]},{"name":"expect constructor()","description":"kotlinx.io.EOFException.EOFException","location":"kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html","searchKeys":["EOFException","expect constructor()","kotlinx.io.EOFException.EOFException"]},{"name":"expect constructor()","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor()","kotlinx.io.IOException.IOException"]},{"name":"expect constructor(cause: Throwable?)","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor(cause: Throwable?)","kotlinx.io.IOException.IOException"]},{"name":"expect constructor(message: String?)","description":"kotlinx.io.EOFException.EOFException","location":"kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html","searchKeys":["EOFException","expect constructor(message: String?)","kotlinx.io.EOFException.EOFException"]},{"name":"expect constructor(message: String?)","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor(message: String?)","kotlinx.io.IOException.IOException"]},{"name":"expect constructor(message: String?)","description":"kotlinx.io.files.FileNotFoundException.FileNotFoundException","location":"kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/-file-not-found-exception.html","searchKeys":["FileNotFoundException","expect constructor(message: String?)","kotlinx.io.files.FileNotFoundException.FileNotFoundException"]},{"name":"expect constructor(message: String?, cause: Throwable?)","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor(message: String?, cause: Throwable?)","kotlinx.io.IOException.IOException"]},{"name":"expect fun Path(path: String): Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path.html","searchKeys":["Path","expect fun Path(path: String): Path","kotlinx.io.files.Path"]},{"name":"expect interface RawSink : AutoCloseable","description":"kotlinx.io.RawSink","location":"kotlinx-io-core/kotlinx.io/-raw-sink/index.html","searchKeys":["RawSink","expect interface RawSink : AutoCloseable","kotlinx.io.RawSink"]},{"name":"expect open class EOFException : IOException","description":"kotlinx.io.EOFException","location":"kotlinx-io-core/kotlinx.io/-e-o-f-exception/index.html","searchKeys":["EOFException","expect open class EOFException : IOException","kotlinx.io.EOFException"]},{"name":"expect open class IOException : Exception","description":"kotlinx.io.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/index.html","searchKeys":["IOException","expect open class IOException : Exception","kotlinx.io.IOException"]},{"name":"expect open operator override fun equals(other: Any?): Boolean","description":"kotlinx.io.files.Path.equals","location":"kotlinx-io-core/kotlinx.io.files/-path/equals.html","searchKeys":["equals","expect open operator override fun equals(other: Any?): Boolean","kotlinx.io.files.Path.equals"]},{"name":"expect open override fun hashCode(): Int","description":"kotlinx.io.files.Path.hashCode","location":"kotlinx-io-core/kotlinx.io.files/-path/hash-code.html","searchKeys":["hashCode","expect open override fun hashCode(): Int","kotlinx.io.files.Path.hashCode"]},{"name":"expect open override fun toString(): String","description":"kotlinx.io.files.Path.toString","location":"kotlinx-io-core/kotlinx.io.files/-path/to-string.html","searchKeys":["toString","expect open override fun toString(): String","kotlinx.io.files.Path.toString"]},{"name":"expect val SystemFileSystem: FileSystem","description":"kotlinx.io.files.SystemFileSystem","location":"kotlinx-io-core/kotlinx.io.files/-system-file-system.html","searchKeys":["SystemFileSystem","expect val SystemFileSystem: FileSystem","kotlinx.io.files.SystemFileSystem"]},{"name":"expect val SystemPathSeparator: Char","description":"kotlinx.io.files.SystemPathSeparator","location":"kotlinx-io-core/kotlinx.io.files/-system-path-separator.html","searchKeys":["SystemPathSeparator","expect val SystemPathSeparator: Char","kotlinx.io.files.SystemPathSeparator"]},{"name":"expect val SystemTemporaryDirectory: Path","description":"kotlinx.io.files.SystemTemporaryDirectory","location":"kotlinx-io-core/kotlinx.io.files/-system-temporary-directory.html","searchKeys":["SystemTemporaryDirectory","expect val SystemTemporaryDirectory: Path","kotlinx.io.files.SystemTemporaryDirectory"]},{"name":"expect val isAbsolute: Boolean","description":"kotlinx.io.files.Path.isAbsolute","location":"kotlinx-io-core/kotlinx.io.files/-path/is-absolute.html","searchKeys":["isAbsolute","expect val isAbsolute: Boolean","kotlinx.io.files.Path.isAbsolute"]},{"name":"expect val name: String","description":"kotlinx.io.files.Path.name","location":"kotlinx-io-core/kotlinx.io.files/-path/name.html","searchKeys":["name","expect val name: String","kotlinx.io.files.Path.name"]},{"name":"expect val parent: Path?","description":"kotlinx.io.files.Path.parent","location":"kotlinx-io-core/kotlinx.io.files/-path/parent.html","searchKeys":["parent","expect val parent: Path?","kotlinx.io.files.Path.parent"]},{"name":"fun Buffer.asByteChannel(): ByteChannel","description":"kotlinx.io.asByteChannel","location":"kotlinx-io-core/kotlinx.io/as-byte-channel.html","searchKeys":["asByteChannel","fun Buffer.asByteChannel(): ByteChannel","kotlinx.io.asByteChannel"]},{"name":"fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)","description":"kotlinx.io.copyTo","location":"kotlinx-io-core/kotlinx.io/copy-to.html","searchKeys":["copyTo","fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)","kotlinx.io.copyTo"]},{"name":"fun Buffer.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = size): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Buffer.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = size): Long","kotlinx.io.indexOf"]},{"name":"fun Buffer.indexOf(byteString: ByteString, startIndex: Long = 0): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Buffer.indexOf(byteString: ByteString, startIndex: Long = 0): Long","kotlinx.io.indexOf"]},{"name":"fun Buffer.readAtMostTo(sink: ByteBuffer): Int","description":"kotlinx.io.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/read-at-most-to.html","searchKeys":["readAtMostTo","fun Buffer.readAtMostTo(sink: ByteBuffer): Int","kotlinx.io.readAtMostTo"]},{"name":"fun Buffer.readString(): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Buffer.readString(): String","kotlinx.io.readString"]},{"name":"fun Buffer.readTo(out: OutputStream, byteCount: Long = size)","description":"kotlinx.io.readTo","location":"kotlinx-io-core/kotlinx.io/read-to.html","searchKeys":["readTo","fun Buffer.readTo(out: OutputStream, byteCount: Long = size)","kotlinx.io.readTo"]},{"name":"fun Buffer.snapshot(): ByteString","description":"kotlinx.io.snapshot","location":"kotlinx-io-core/kotlinx.io/snapshot.html","searchKeys":["snapshot","fun Buffer.snapshot(): ByteString","kotlinx.io.snapshot"]},{"name":"fun Buffer.transferFrom(input: InputStream): Buffer","description":"kotlinx.io.transferFrom","location":"kotlinx-io-core/kotlinx.io/transfer-from.html","searchKeys":["transferFrom","fun Buffer.transferFrom(input: InputStream): Buffer","kotlinx.io.transferFrom"]},{"name":"fun Buffer.transferFrom(source: ByteBuffer): Buffer","description":"kotlinx.io.transferFrom","location":"kotlinx-io-core/kotlinx.io/transfer-from.html","searchKeys":["transferFrom","fun Buffer.transferFrom(source: ByteBuffer): Buffer","kotlinx.io.transferFrom"]},{"name":"fun Buffer.write(input: InputStream, byteCount: Long): Buffer","description":"kotlinx.io.write","location":"kotlinx-io-core/kotlinx.io/write.html","searchKeys":["write","fun Buffer.write(input: InputStream, byteCount: Long): Buffer","kotlinx.io.write"]},{"name":"fun InputStream.asSource(): RawSource","description":"kotlinx.io.asSource","location":"kotlinx-io-core/kotlinx.io/as-source.html","searchKeys":["asSource","fun InputStream.asSource(): RawSource","kotlinx.io.asSource"]},{"name":"fun NSInputStream.asSource(): RawSource","description":"kotlinx.io.asSource","location":"kotlinx-io-core/kotlinx.io/as-source.html","searchKeys":["asSource","fun NSInputStream.asSource(): RawSource","kotlinx.io.asSource"]},{"name":"fun NSOutputStream.asSink(): RawSink","description":"kotlinx.io.asSink","location":"kotlinx-io-core/kotlinx.io/as-sink.html","searchKeys":["asSink","fun NSOutputStream.asSink(): RawSink","kotlinx.io.asSink"]},{"name":"fun OutputStream.asSink(): RawSink","description":"kotlinx.io.asSink","location":"kotlinx-io-core/kotlinx.io/as-sink.html","searchKeys":["asSink","fun OutputStream.asSink(): RawSink","kotlinx.io.asSink"]},{"name":"fun Path(base: Path, vararg parts: String): Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path.html","searchKeys":["Path","fun Path(base: Path, vararg parts: String): Path","kotlinx.io.files.Path"]},{"name":"fun Path(base: String, vararg parts: String): Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path.html","searchKeys":["Path","fun Path(base: String, vararg parts: String): Path","kotlinx.io.files.Path"]},{"name":"fun Path.sink(): Sink","description":"kotlinx.io.files.sink","location":"kotlinx-io-core/kotlinx.io.files/sink.html","searchKeys":["sink","fun Path.sink(): Sink","kotlinx.io.files.sink"]},{"name":"fun Path.source(): Source","description":"kotlinx.io.files.source","location":"kotlinx-io-core/kotlinx.io.files/source.html","searchKeys":["source","fun Path.source(): Source","kotlinx.io.files.source"]},{"name":"fun RawSink.buffered(): Sink","description":"kotlinx.io.buffered","location":"kotlinx-io-core/kotlinx.io/buffered.html","searchKeys":["buffered","fun RawSink.buffered(): Sink","kotlinx.io.buffered"]},{"name":"fun RawSource.buffered(): Source","description":"kotlinx.io.buffered","location":"kotlinx-io-core/kotlinx.io/buffered.html","searchKeys":["buffered","fun RawSource.buffered(): Source","kotlinx.io.buffered"]},{"name":"fun Sink.asByteChannel(): WritableByteChannel","description":"kotlinx.io.asByteChannel","location":"kotlinx-io-core/kotlinx.io/as-byte-channel.html","searchKeys":["asByteChannel","fun Sink.asByteChannel(): WritableByteChannel","kotlinx.io.asByteChannel"]},{"name":"fun Sink.asNSOutputStream(): NSOutputStream","description":"kotlinx.io.asNSOutputStream","location":"kotlinx-io-core/kotlinx.io/as-n-s-output-stream.html","searchKeys":["asNSOutputStream","fun Sink.asNSOutputStream(): NSOutputStream","kotlinx.io.asNSOutputStream"]},{"name":"fun Sink.asOutputStream(): OutputStream","description":"kotlinx.io.asOutputStream","location":"kotlinx-io-core/kotlinx.io/as-output-stream.html","searchKeys":["asOutputStream","fun Sink.asOutputStream(): OutputStream","kotlinx.io.asOutputStream"]},{"name":"fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)","description":"kotlinx.io.write","location":"kotlinx-io-core/kotlinx.io/write.html","searchKeys":["write","fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)","kotlinx.io.write"]},{"name":"fun Sink.write(source: ByteBuffer): Int","description":"kotlinx.io.write","location":"kotlinx-io-core/kotlinx.io/write.html","searchKeys":["write","fun Sink.write(source: ByteBuffer): Int","kotlinx.io.write"]},{"name":"fun Sink.writeCodePointValue(codePoint: Int)","description":"kotlinx.io.writeCodePointValue","location":"kotlinx-io-core/kotlinx.io/write-code-point-value.html","searchKeys":["writeCodePointValue","fun Sink.writeCodePointValue(codePoint: Int)","kotlinx.io.writeCodePointValue"]},{"name":"fun Sink.writeDecimalLong(long: Long)","description":"kotlinx.io.writeDecimalLong","location":"kotlinx-io-core/kotlinx.io/write-decimal-long.html","searchKeys":["writeDecimalLong","fun Sink.writeDecimalLong(long: Long)","kotlinx.io.writeDecimalLong"]},{"name":"fun Sink.writeDouble(double: Double)","description":"kotlinx.io.writeDouble","location":"kotlinx-io-core/kotlinx.io/write-double.html","searchKeys":["writeDouble","fun Sink.writeDouble(double: Double)","kotlinx.io.writeDouble"]},{"name":"fun Sink.writeDoubleLe(double: Double)","description":"kotlinx.io.writeDoubleLe","location":"kotlinx-io-core/kotlinx.io/write-double-le.html","searchKeys":["writeDoubleLe","fun Sink.writeDoubleLe(double: Double)","kotlinx.io.writeDoubleLe"]},{"name":"fun Sink.writeFloat(float: Float)","description":"kotlinx.io.writeFloat","location":"kotlinx-io-core/kotlinx.io/write-float.html","searchKeys":["writeFloat","fun Sink.writeFloat(float: Float)","kotlinx.io.writeFloat"]},{"name":"fun Sink.writeFloatLe(float: Float)","description":"kotlinx.io.writeFloatLe","location":"kotlinx-io-core/kotlinx.io/write-float-le.html","searchKeys":["writeFloatLe","fun Sink.writeFloatLe(float: Float)","kotlinx.io.writeFloatLe"]},{"name":"fun Sink.writeHexadecimalUnsignedLong(long: Long)","description":"kotlinx.io.writeHexadecimalUnsignedLong","location":"kotlinx-io-core/kotlinx.io/write-hexadecimal-unsigned-long.html","searchKeys":["writeHexadecimalUnsignedLong","fun Sink.writeHexadecimalUnsignedLong(long: Long)","kotlinx.io.writeHexadecimalUnsignedLong"]},{"name":"fun Sink.writeIntLe(int: Int)","description":"kotlinx.io.writeIntLe","location":"kotlinx-io-core/kotlinx.io/write-int-le.html","searchKeys":["writeIntLe","fun Sink.writeIntLe(int: Int)","kotlinx.io.writeIntLe"]},{"name":"fun Sink.writeLongLe(long: Long)","description":"kotlinx.io.writeLongLe","location":"kotlinx-io-core/kotlinx.io/write-long-le.html","searchKeys":["writeLongLe","fun Sink.writeLongLe(long: Long)","kotlinx.io.writeLongLe"]},{"name":"fun Sink.writeShortLe(short: Short)","description":"kotlinx.io.writeShortLe","location":"kotlinx-io-core/kotlinx.io/write-short-le.html","searchKeys":["writeShortLe","fun Sink.writeShortLe(short: Short)","kotlinx.io.writeShortLe"]},{"name":"fun Sink.writeString(chars: CharSequence, startIndex: Int = 0, endIndex: Int = chars.length)","description":"kotlinx.io.writeString","location":"kotlinx-io-core/kotlinx.io/write-string.html","searchKeys":["writeString","fun Sink.writeString(chars: CharSequence, startIndex: Int = 0, endIndex: Int = chars.length)","kotlinx.io.writeString"]},{"name":"fun Sink.writeString(string: String, charset: Charset, startIndex: Int = 0, endIndex: Int = string.length)","description":"kotlinx.io.writeString","location":"kotlinx-io-core/kotlinx.io/write-string.html","searchKeys":["writeString","fun Sink.writeString(string: String, charset: Charset, startIndex: Int = 0, endIndex: Int = string.length)","kotlinx.io.writeString"]},{"name":"fun Sink.writeString(string: String, startIndex: Int = 0, endIndex: Int = string.length)","description":"kotlinx.io.writeString","location":"kotlinx-io-core/kotlinx.io/write-string.html","searchKeys":["writeString","fun Sink.writeString(string: String, startIndex: Int = 0, endIndex: Int = string.length)","kotlinx.io.writeString"]},{"name":"fun Sink.writeUByte(byte: UByte)","description":"kotlinx.io.writeUByte","location":"kotlinx-io-core/kotlinx.io/write-u-byte.html","searchKeys":["writeUByte","fun Sink.writeUByte(byte: UByte)","kotlinx.io.writeUByte"]},{"name":"fun Sink.writeUInt(int: UInt)","description":"kotlinx.io.writeUInt","location":"kotlinx-io-core/kotlinx.io/write-u-int.html","searchKeys":["writeUInt","fun Sink.writeUInt(int: UInt)","kotlinx.io.writeUInt"]},{"name":"fun Sink.writeUIntLe(int: UInt)","description":"kotlinx.io.writeUIntLe","location":"kotlinx-io-core/kotlinx.io/write-u-int-le.html","searchKeys":["writeUIntLe","fun Sink.writeUIntLe(int: UInt)","kotlinx.io.writeUIntLe"]},{"name":"fun Sink.writeULong(long: ULong)","description":"kotlinx.io.writeULong","location":"kotlinx-io-core/kotlinx.io/write-u-long.html","searchKeys":["writeULong","fun Sink.writeULong(long: ULong)","kotlinx.io.writeULong"]},{"name":"fun Sink.writeULongLe(long: ULong)","description":"kotlinx.io.writeULongLe","location":"kotlinx-io-core/kotlinx.io/write-u-long-le.html","searchKeys":["writeULongLe","fun Sink.writeULongLe(long: ULong)","kotlinx.io.writeULongLe"]},{"name":"fun Sink.writeUShort(short: UShort)","description":"kotlinx.io.writeUShort","location":"kotlinx-io-core/kotlinx.io/write-u-short.html","searchKeys":["writeUShort","fun Sink.writeUShort(short: UShort)","kotlinx.io.writeUShort"]},{"name":"fun Sink.writeUShortLe(short: UShort)","description":"kotlinx.io.writeUShortLe","location":"kotlinx-io-core/kotlinx.io/write-u-short-le.html","searchKeys":["writeUShortLe","fun Sink.writeUShortLe(short: UShort)","kotlinx.io.writeUShortLe"]},{"name":"fun Source.asByteChannel(): ReadableByteChannel","description":"kotlinx.io.asByteChannel","location":"kotlinx-io-core/kotlinx.io/as-byte-channel.html","searchKeys":["asByteChannel","fun Source.asByteChannel(): ReadableByteChannel","kotlinx.io.asByteChannel"]},{"name":"fun Source.asInputStream(): InputStream","description":"kotlinx.io.asInputStream","location":"kotlinx-io-core/kotlinx.io/as-input-stream.html","searchKeys":["asInputStream","fun Source.asInputStream(): InputStream","kotlinx.io.asInputStream"]},{"name":"fun Source.asNSInputStream(): NSInputStream","description":"kotlinx.io.asNSInputStream","location":"kotlinx-io-core/kotlinx.io/as-n-s-input-stream.html","searchKeys":["asNSInputStream","fun Source.asNSInputStream(): NSInputStream","kotlinx.io.asNSInputStream"]},{"name":"fun Source.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = Long.MAX_VALUE): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Source.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = Long.MAX_VALUE): Long","kotlinx.io.indexOf"]},{"name":"fun Source.indexOf(byteString: ByteString, startIndex: Long = 0): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Source.indexOf(byteString: ByteString, startIndex: Long = 0): Long","kotlinx.io.indexOf"]},{"name":"fun Source.readAtMostTo(sink: ByteBuffer): Int","description":"kotlinx.io.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/read-at-most-to.html","searchKeys":["readAtMostTo","fun Source.readAtMostTo(sink: ByteBuffer): Int","kotlinx.io.readAtMostTo"]},{"name":"fun Source.readByteArray(): ByteArray","description":"kotlinx.io.readByteArray","location":"kotlinx-io-core/kotlinx.io/read-byte-array.html","searchKeys":["readByteArray","fun Source.readByteArray(): ByteArray","kotlinx.io.readByteArray"]},{"name":"fun Source.readByteArray(byteCount: Int): ByteArray","description":"kotlinx.io.readByteArray","location":"kotlinx-io-core/kotlinx.io/read-byte-array.html","searchKeys":["readByteArray","fun Source.readByteArray(byteCount: Int): ByteArray","kotlinx.io.readByteArray"]},{"name":"fun Source.readByteString(): ByteString","description":"kotlinx.io.readByteString","location":"kotlinx-io-core/kotlinx.io/read-byte-string.html","searchKeys":["readByteString","fun Source.readByteString(): ByteString","kotlinx.io.readByteString"]},{"name":"fun Source.readByteString(byteCount: Int): ByteString","description":"kotlinx.io.readByteString","location":"kotlinx-io-core/kotlinx.io/read-byte-string.html","searchKeys":["readByteString","fun Source.readByteString(byteCount: Int): ByteString","kotlinx.io.readByteString"]},{"name":"fun Source.readCodePointValue(): Int","description":"kotlinx.io.readCodePointValue","location":"kotlinx-io-core/kotlinx.io/read-code-point-value.html","searchKeys":["readCodePointValue","fun Source.readCodePointValue(): Int","kotlinx.io.readCodePointValue"]},{"name":"fun Source.readDecimalLong(): Long","description":"kotlinx.io.readDecimalLong","location":"kotlinx-io-core/kotlinx.io/read-decimal-long.html","searchKeys":["readDecimalLong","fun Source.readDecimalLong(): Long","kotlinx.io.readDecimalLong"]},{"name":"fun Source.readDouble(): Double","description":"kotlinx.io.readDouble","location":"kotlinx-io-core/kotlinx.io/read-double.html","searchKeys":["readDouble","fun Source.readDouble(): Double","kotlinx.io.readDouble"]},{"name":"fun Source.readDoubleLe(): Double","description":"kotlinx.io.readDoubleLe","location":"kotlinx-io-core/kotlinx.io/read-double-le.html","searchKeys":["readDoubleLe","fun Source.readDoubleLe(): Double","kotlinx.io.readDoubleLe"]},{"name":"fun Source.readFloat(): Float","description":"kotlinx.io.readFloat","location":"kotlinx-io-core/kotlinx.io/read-float.html","searchKeys":["readFloat","fun Source.readFloat(): Float","kotlinx.io.readFloat"]},{"name":"fun Source.readFloatLe(): Float","description":"kotlinx.io.readFloatLe","location":"kotlinx-io-core/kotlinx.io/read-float-le.html","searchKeys":["readFloatLe","fun Source.readFloatLe(): Float","kotlinx.io.readFloatLe"]},{"name":"fun Source.readHexadecimalUnsignedLong(): Long","description":"kotlinx.io.readHexadecimalUnsignedLong","location":"kotlinx-io-core/kotlinx.io/read-hexadecimal-unsigned-long.html","searchKeys":["readHexadecimalUnsignedLong","fun Source.readHexadecimalUnsignedLong(): Long","kotlinx.io.readHexadecimalUnsignedLong"]},{"name":"fun Source.readIntLe(): Int","description":"kotlinx.io.readIntLe","location":"kotlinx-io-core/kotlinx.io/read-int-le.html","searchKeys":["readIntLe","fun Source.readIntLe(): Int","kotlinx.io.readIntLe"]},{"name":"fun Source.readLine(): String?","description":"kotlinx.io.readLine","location":"kotlinx-io-core/kotlinx.io/read-line.html","searchKeys":["readLine","fun Source.readLine(): String?","kotlinx.io.readLine"]},{"name":"fun Source.readLineStrict(limit: Long = Long.MAX_VALUE): String","description":"kotlinx.io.readLineStrict","location":"kotlinx-io-core/kotlinx.io/read-line-strict.html","searchKeys":["readLineStrict","fun Source.readLineStrict(limit: Long = Long.MAX_VALUE): String","kotlinx.io.readLineStrict"]},{"name":"fun Source.readLongLe(): Long","description":"kotlinx.io.readLongLe","location":"kotlinx-io-core/kotlinx.io/read-long-le.html","searchKeys":["readLongLe","fun Source.readLongLe(): Long","kotlinx.io.readLongLe"]},{"name":"fun Source.readShortLe(): Short","description":"kotlinx.io.readShortLe","location":"kotlinx-io-core/kotlinx.io/read-short-le.html","searchKeys":["readShortLe","fun Source.readShortLe(): Short","kotlinx.io.readShortLe"]},{"name":"fun Source.readString(): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(): String","kotlinx.io.readString"]},{"name":"fun Source.readString(byteCount: Long): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(byteCount: Long): String","kotlinx.io.readString"]},{"name":"fun Source.readString(byteCount: Long, charset: Charset): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(byteCount: Long, charset: Charset): String","kotlinx.io.readString"]},{"name":"fun Source.readString(charset: Charset): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(charset: Charset): String","kotlinx.io.readString"]},{"name":"fun Source.readTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size)","description":"kotlinx.io.readTo","location":"kotlinx-io-core/kotlinx.io/read-to.html","searchKeys":["readTo","fun Source.readTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size)","kotlinx.io.readTo"]},{"name":"fun Source.readUByte(): UByte","description":"kotlinx.io.readUByte","location":"kotlinx-io-core/kotlinx.io/read-u-byte.html","searchKeys":["readUByte","fun Source.readUByte(): UByte","kotlinx.io.readUByte"]},{"name":"fun Source.readUInt(): UInt","description":"kotlinx.io.readUInt","location":"kotlinx-io-core/kotlinx.io/read-u-int.html","searchKeys":["readUInt","fun Source.readUInt(): UInt","kotlinx.io.readUInt"]},{"name":"fun Source.readUIntLe(): UInt","description":"kotlinx.io.readUIntLe","location":"kotlinx-io-core/kotlinx.io/read-u-int-le.html","searchKeys":["readUIntLe","fun Source.readUIntLe(): UInt","kotlinx.io.readUIntLe"]},{"name":"fun Source.readULong(): ULong","description":"kotlinx.io.readULong","location":"kotlinx-io-core/kotlinx.io/read-u-long.html","searchKeys":["readULong","fun Source.readULong(): ULong","kotlinx.io.readULong"]},{"name":"fun Source.readULongLe(): ULong","description":"kotlinx.io.readULongLe","location":"kotlinx-io-core/kotlinx.io/read-u-long-le.html","searchKeys":["readULongLe","fun Source.readULongLe(): ULong","kotlinx.io.readULongLe"]},{"name":"fun Source.readUShort(): UShort","description":"kotlinx.io.readUShort","location":"kotlinx-io-core/kotlinx.io/read-u-short.html","searchKeys":["readUShort","fun Source.readUShort(): UShort","kotlinx.io.readUShort"]},{"name":"fun Source.readUShortLe(): UShort","description":"kotlinx.io.readUShortLe","location":"kotlinx-io-core/kotlinx.io/read-u-short-le.html","searchKeys":["readUShortLe","fun Source.readUShortLe(): UShort","kotlinx.io.readUShortLe"]},{"name":"fun Source.startsWith(byte: Byte): Boolean","description":"kotlinx.io.startsWith","location":"kotlinx-io-core/kotlinx.io/starts-with.html","searchKeys":["startsWith","fun Source.startsWith(byte: Byte): Boolean","kotlinx.io.startsWith"]},{"name":"fun clear()","description":"kotlinx.io.Buffer.clear","location":"kotlinx-io-core/kotlinx.io/-buffer/clear.html","searchKeys":["clear","fun clear()","kotlinx.io.Buffer.clear"]},{"name":"fun copy(): Buffer","description":"kotlinx.io.Buffer.copy","location":"kotlinx-io-core/kotlinx.io/-buffer/copy.html","searchKeys":["copy","fun copy(): Buffer","kotlinx.io.Buffer.copy"]},{"name":"fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)","description":"kotlinx.io.Buffer.copyTo","location":"kotlinx-io-core/kotlinx.io/-buffer/copy-to.html","searchKeys":["copyTo","fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)","kotlinx.io.Buffer.copyTo"]},{"name":"fun discardingSink(): RawSink","description":"kotlinx.io.discardingSink","location":"kotlinx-io-core/kotlinx.io/discarding-sink.html","searchKeys":["discardingSink","fun discardingSink(): RawSink","kotlinx.io.discardingSink"]},{"name":"inline fun Sink.writeToInternalBuffer(lambda: (Buffer) -> Unit)","description":"kotlinx.io.writeToInternalBuffer","location":"kotlinx-io-core/kotlinx.io/write-to-internal-buffer.html","searchKeys":["writeToInternalBuffer","inline fun Sink.writeToInternalBuffer(lambda: (Buffer) -> Unit)","kotlinx.io.writeToInternalBuffer"]},{"name":"interface RawSource : AutoCloseable","description":"kotlinx.io.RawSource","location":"kotlinx-io-core/kotlinx.io/-raw-source/index.html","searchKeys":["RawSource","interface RawSource : AutoCloseable","kotlinx.io.RawSource"]},{"name":"open override fun close()","description":"kotlinx.io.Buffer.close","location":"kotlinx-io-core/kotlinx.io/-buffer/close.html","searchKeys":["close","open override fun close()","kotlinx.io.Buffer.close"]},{"name":"open override fun emit()","description":"kotlinx.io.Buffer.emit","location":"kotlinx-io-core/kotlinx.io/-buffer/emit.html","searchKeys":["emit","open override fun emit()","kotlinx.io.Buffer.emit"]},{"name":"open override fun exhausted(): Boolean","description":"kotlinx.io.Buffer.exhausted","location":"kotlinx-io-core/kotlinx.io/-buffer/exhausted.html","searchKeys":["exhausted","open override fun exhausted(): Boolean","kotlinx.io.Buffer.exhausted"]},{"name":"open override fun flush()","description":"kotlinx.io.Buffer.flush","location":"kotlinx-io-core/kotlinx.io/-buffer/flush.html","searchKeys":["flush","open override fun flush()","kotlinx.io.Buffer.flush"]},{"name":"open override fun hintEmit()","description":"kotlinx.io.Buffer.hintEmit","location":"kotlinx-io-core/kotlinx.io/-buffer/hint-emit.html","searchKeys":["hintEmit","open override fun hintEmit()","kotlinx.io.Buffer.hintEmit"]},{"name":"open override fun peek(): Source","description":"kotlinx.io.Buffer.peek","location":"kotlinx-io-core/kotlinx.io/-buffer/peek.html","searchKeys":["peek","open override fun peek(): Source","kotlinx.io.Buffer.peek"]},{"name":"open override fun readAtMostTo(sink: Buffer, byteCount: Long): Long","description":"kotlinx.io.Buffer.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html","searchKeys":["readAtMostTo","open override fun readAtMostTo(sink: Buffer, byteCount: Long): Long","kotlinx.io.Buffer.readAtMostTo"]},{"name":"open override fun readAtMostTo(sink: ByteArray, startIndex: Int, endIndex: Int): Int","description":"kotlinx.io.Buffer.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html","searchKeys":["readAtMostTo","open override fun readAtMostTo(sink: ByteArray, startIndex: Int, endIndex: Int): Int","kotlinx.io.Buffer.readAtMostTo"]},{"name":"open override fun readByte(): Byte","description":"kotlinx.io.Buffer.readByte","location":"kotlinx-io-core/kotlinx.io/-buffer/read-byte.html","searchKeys":["readByte","open override fun readByte(): Byte","kotlinx.io.Buffer.readByte"]},{"name":"open override fun readInt(): Int","description":"kotlinx.io.Buffer.readInt","location":"kotlinx-io-core/kotlinx.io/-buffer/read-int.html","searchKeys":["readInt","open override fun readInt(): Int","kotlinx.io.Buffer.readInt"]},{"name":"open override fun readLong(): Long","description":"kotlinx.io.Buffer.readLong","location":"kotlinx-io-core/kotlinx.io/-buffer/read-long.html","searchKeys":["readLong","open override fun readLong(): Long","kotlinx.io.Buffer.readLong"]},{"name":"open override fun readShort(): Short","description":"kotlinx.io.Buffer.readShort","location":"kotlinx-io-core/kotlinx.io/-buffer/read-short.html","searchKeys":["readShort","open override fun readShort(): Short","kotlinx.io.Buffer.readShort"]},{"name":"open override fun readTo(sink: RawSink, byteCount: Long)","description":"kotlinx.io.Buffer.readTo","location":"kotlinx-io-core/kotlinx.io/-buffer/read-to.html","searchKeys":["readTo","open override fun readTo(sink: RawSink, byteCount: Long)","kotlinx.io.Buffer.readTo"]},{"name":"open override fun request(byteCount: Long): Boolean","description":"kotlinx.io.Buffer.request","location":"kotlinx-io-core/kotlinx.io/-buffer/request.html","searchKeys":["request","open override fun request(byteCount: Long): Boolean","kotlinx.io.Buffer.request"]},{"name":"open override fun require(byteCount: Long)","description":"kotlinx.io.Buffer.require","location":"kotlinx-io-core/kotlinx.io/-buffer/require.html","searchKeys":["require","open override fun require(byteCount: Long)","kotlinx.io.Buffer.require"]},{"name":"open override fun skip(byteCount: Long)","description":"kotlinx.io.Buffer.skip","location":"kotlinx-io-core/kotlinx.io/-buffer/skip.html","searchKeys":["skip","open override fun skip(byteCount: Long)","kotlinx.io.Buffer.skip"]},{"name":"open override fun toString(): String","description":"kotlinx.io.Buffer.toString","location":"kotlinx-io-core/kotlinx.io/-buffer/to-string.html","searchKeys":["toString","open override fun toString(): String","kotlinx.io.Buffer.toString"]},{"name":"open override fun transferFrom(source: RawSource): Long","description":"kotlinx.io.Buffer.transferFrom","location":"kotlinx-io-core/kotlinx.io/-buffer/transfer-from.html","searchKeys":["transferFrom","open override fun transferFrom(source: RawSource): Long","kotlinx.io.Buffer.transferFrom"]},{"name":"open override fun transferTo(sink: RawSink): Long","description":"kotlinx.io.Buffer.transferTo","location":"kotlinx-io-core/kotlinx.io/-buffer/transfer-to.html","searchKeys":["transferTo","open override fun transferTo(sink: RawSink): Long","kotlinx.io.Buffer.transferTo"]},{"name":"open override fun write(source: Buffer, byteCount: Long)","description":"kotlinx.io.Buffer.write","location":"kotlinx-io-core/kotlinx.io/-buffer/write.html","searchKeys":["write","open override fun write(source: Buffer, byteCount: Long)","kotlinx.io.Buffer.write"]},{"name":"open override fun write(source: ByteArray, startIndex: Int, endIndex: Int)","description":"kotlinx.io.Buffer.write","location":"kotlinx-io-core/kotlinx.io/-buffer/write.html","searchKeys":["write","open override fun write(source: ByteArray, startIndex: Int, endIndex: Int)","kotlinx.io.Buffer.write"]},{"name":"open override fun write(source: RawSource, byteCount: Long)","description":"kotlinx.io.Buffer.write","location":"kotlinx-io-core/kotlinx.io/-buffer/write.html","searchKeys":["write","open override fun write(source: RawSource, byteCount: Long)","kotlinx.io.Buffer.write"]},{"name":"open override fun writeByte(byte: Byte)","description":"kotlinx.io.Buffer.writeByte","location":"kotlinx-io-core/kotlinx.io/-buffer/write-byte.html","searchKeys":["writeByte","open override fun writeByte(byte: Byte)","kotlinx.io.Buffer.writeByte"]},{"name":"open override fun writeInt(int: Int)","description":"kotlinx.io.Buffer.writeInt","location":"kotlinx-io-core/kotlinx.io/-buffer/write-int.html","searchKeys":["writeInt","open override fun writeInt(int: Int)","kotlinx.io.Buffer.writeInt"]},{"name":"open override fun writeLong(long: Long)","description":"kotlinx.io.Buffer.writeLong","location":"kotlinx-io-core/kotlinx.io/-buffer/write-long.html","searchKeys":["writeLong","open override fun writeLong(long: Long)","kotlinx.io.Buffer.writeLong"]},{"name":"open override fun writeShort(short: Short)","description":"kotlinx.io.Buffer.writeShort","location":"kotlinx-io-core/kotlinx.io/-buffer/write-short.html","searchKeys":["writeShort","open override fun writeShort(short: Short)","kotlinx.io.Buffer.writeShort"]},{"name":"open override val buffer: Buffer","description":"kotlinx.io.Buffer.buffer","location":"kotlinx-io-core/kotlinx.io/-buffer/buffer.html","searchKeys":["buffer","open override val buffer: Buffer","kotlinx.io.Buffer.buffer"]},{"name":"operator fun get(position: Long): Byte","description":"kotlinx.io.Buffer.get","location":"kotlinx-io-core/kotlinx.io/-buffer/get.html","searchKeys":["get","operator fun get(position: Long): Byte","kotlinx.io.Buffer.get"]},{"name":"sealed interface FileSystem","description":"kotlinx.io.files.FileSystem","location":"kotlinx-io-core/kotlinx.io.files/-file-system/index.html","searchKeys":["FileSystem","sealed interface FileSystem","kotlinx.io.files.FileSystem"]},{"name":"sealed interface Sink : RawSink","description":"kotlinx.io.Sink","location":"kotlinx-io-core/kotlinx.io/-sink/index.html","searchKeys":["Sink","sealed interface Sink : RawSink","kotlinx.io.Sink"]},{"name":"sealed interface Source : RawSource","description":"kotlinx.io.Source","location":"kotlinx-io-core/kotlinx.io/-source/index.html","searchKeys":["Source","sealed interface Source : RawSource","kotlinx.io.Source"]},{"name":"val isDirectory: Boolean = false","description":"kotlinx.io.files.FileMetadata.isDirectory","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/is-directory.html","searchKeys":["isDirectory","val isDirectory: Boolean = false","kotlinx.io.files.FileMetadata.isDirectory"]},{"name":"val isRegularFile: Boolean = false","description":"kotlinx.io.files.FileMetadata.isRegularFile","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/is-regular-file.html","searchKeys":["isRegularFile","val isRegularFile: Boolean = false","kotlinx.io.files.FileMetadata.isRegularFile"]},{"name":"val size: Long","description":"kotlinx.io.Buffer.size","location":"kotlinx-io-core/kotlinx.io/-buffer/size.html","searchKeys":["size","val size: Long","kotlinx.io.Buffer.size"]},{"name":"val size: Long = 0","description":"kotlinx.io.files.FileMetadata.size","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/size.html","searchKeys":["size","val size: Long = 0","kotlinx.io.files.FileMetadata.size"]}] \ No newline at end of file +[{"name":"class ByteString : Comparable ","description":"kotlinx.io.bytestring.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/index.html","searchKeys":["ByteString","class ByteString : Comparable ","kotlinx.io.bytestring.ByteString"]},{"name":"class ByteStringBuilder(initialCapacity: Int = 0)","description":"kotlinx.io.bytestring.ByteStringBuilder","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html","searchKeys":["ByteStringBuilder","class ByteStringBuilder(initialCapacity: Int = 0)","kotlinx.io.bytestring.ByteStringBuilder"]},{"name":"constructor(data: ByteArray, startIndex: Int = 0, endIndex: Int = data.size)","description":"kotlinx.io.bytestring.ByteString.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-byte-string.html","searchKeys":["ByteString","constructor(data: ByteArray, startIndex: Int = 0, endIndex: Int = data.size)","kotlinx.io.bytestring.ByteString.ByteString"]},{"name":"constructor(initialCapacity: Int = 0)","description":"kotlinx.io.bytestring.ByteStringBuilder.ByteStringBuilder","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html","searchKeys":["ByteStringBuilder","constructor(initialCapacity: Int = 0)","kotlinx.io.bytestring.ByteStringBuilder.ByteStringBuilder"]},{"name":"fun Base64.encodeToAppendable(source: ByteString, destination: A, startIndex: Int = 0, endIndex: Int = source.size): A","description":"kotlinx.io.bytestring.encodeToAppendable","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-appendable.html","searchKeys":["encodeToAppendable","fun Base64.encodeToAppendable(source: ByteString, destination: A, startIndex: Int = 0, endIndex: Int = source.size): A","kotlinx.io.bytestring.encodeToAppendable"]},{"name":"fun Base64.decode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","description":"kotlinx.io.bytestring.decode","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode.html","searchKeys":["decode","fun Base64.decode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","kotlinx.io.bytestring.decode"]},{"name":"fun Base64.decodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","description":"kotlinx.io.bytestring.decodeIntoByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-into-byte-array.html","searchKeys":["decodeIntoByteArray","fun Base64.decodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","kotlinx.io.bytestring.decodeIntoByteArray"]},{"name":"fun Base64.decodeToByteString(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): ByteString","description":"kotlinx.io.bytestring.decodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html","searchKeys":["decodeToByteString","fun Base64.decodeToByteString(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size): ByteString","kotlinx.io.bytestring.decodeToByteString"]},{"name":"fun Base64.decodeToByteString(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteString","description":"kotlinx.io.bytestring.decodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html","searchKeys":["decodeToByteString","fun Base64.decodeToByteString(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteString","kotlinx.io.bytestring.decodeToByteString"]},{"name":"fun Base64.decodeToByteString(source: CharSequence, startIndex: Int = 0, endIndex: Int = source.length): ByteString","description":"kotlinx.io.bytestring.decodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-byte-string.html","searchKeys":["decodeToByteString","fun Base64.decodeToByteString(source: CharSequence, startIndex: Int = 0, endIndex: Int = source.length): ByteString","kotlinx.io.bytestring.decodeToByteString"]},{"name":"fun Base64.encode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): String","description":"kotlinx.io.bytestring.encode","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode.html","searchKeys":["encode","fun Base64.encode(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): String","kotlinx.io.bytestring.encode"]},{"name":"fun Base64.encodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","description":"kotlinx.io.bytestring.encodeIntoByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-into-byte-array.html","searchKeys":["encodeIntoByteArray","fun Base64.encodeIntoByteArray(source: ByteString, destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = source.size): Int","kotlinx.io.bytestring.encodeIntoByteArray"]},{"name":"fun Base64.encodeToByteArray(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","description":"kotlinx.io.bytestring.encodeToByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-array.html","searchKeys":["encodeToByteArray","fun Base64.encodeToByteArray(source: ByteString, startIndex: Int = 0, endIndex: Int = source.size): ByteArray","kotlinx.io.bytestring.encodeToByteArray"]},{"name":"fun ByteBuffer.getByteString(at: Int, length: Int): ByteString","description":"kotlinx.io.bytestring.getByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/get-byte-string.html","searchKeys":["getByteString","fun ByteBuffer.getByteString(at: Int, length: Int): ByteString","kotlinx.io.bytestring.getByteString"]},{"name":"fun ByteBuffer.getByteString(length: Int = remaining()): ByteString","description":"kotlinx.io.bytestring.getByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/get-byte-string.html","searchKeys":["getByteString","fun ByteBuffer.getByteString(length: Int = remaining()): ByteString","kotlinx.io.bytestring.getByteString"]},{"name":"fun ByteBuffer.putByteString(at: Int, string: ByteString)","description":"kotlinx.io.bytestring.putByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/put-byte-string.html","searchKeys":["putByteString","fun ByteBuffer.putByteString(at: Int, string: ByteString)","kotlinx.io.bytestring.putByteString"]},{"name":"fun ByteBuffer.putByteString(string: ByteString)","description":"kotlinx.io.bytestring.putByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/put-byte-string.html","searchKeys":["putByteString","fun ByteBuffer.putByteString(string: ByteString)","kotlinx.io.bytestring.putByteString"]},{"name":"fun ByteString(): ByteString","description":"kotlinx.io.bytestring.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html","searchKeys":["ByteString","fun ByteString(): ByteString","kotlinx.io.bytestring.ByteString"]},{"name":"fun ByteString(vararg bytes: Byte): ByteString","description":"kotlinx.io.bytestring.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html","searchKeys":["ByteString","fun ByteString(vararg bytes: Byte): ByteString","kotlinx.io.bytestring.ByteString"]},{"name":"fun ByteString(vararg bytes: UByte): ByteString","description":"kotlinx.io.bytestring.ByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html","searchKeys":["ByteString","fun ByteString(vararg bytes: UByte): ByteString","kotlinx.io.bytestring.ByteString"]},{"name":"fun ByteString.asReadOnlyByteBuffer(): ByteBuffer","description":"kotlinx.io.bytestring.asReadOnlyByteBuffer","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/as-read-only-byte-buffer.html","searchKeys":["asReadOnlyByteBuffer","fun ByteString.asReadOnlyByteBuffer(): ByteBuffer","kotlinx.io.bytestring.asReadOnlyByteBuffer"]},{"name":"fun ByteString.contentEquals(array: ByteArray): Boolean","description":"kotlinx.io.bytestring.contentEquals","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/content-equals.html","searchKeys":["contentEquals","fun ByteString.contentEquals(array: ByteArray): Boolean","kotlinx.io.bytestring.contentEquals"]},{"name":"fun ByteString.decodeToString(): String","description":"kotlinx.io.bytestring.decodeToString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html","searchKeys":["decodeToString","fun ByteString.decodeToString(): String","kotlinx.io.bytestring.decodeToString"]},{"name":"fun ByteString.decodeToString(charset: Charset): String","description":"kotlinx.io.bytestring.decodeToString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/decode-to-string.html","searchKeys":["decodeToString","fun ByteString.decodeToString(charset: Charset): String","kotlinx.io.bytestring.decodeToString"]},{"name":"fun ByteString.endsWith(byteArray: ByteArray): Boolean","description":"kotlinx.io.bytestring.endsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html","searchKeys":["endsWith","fun ByteString.endsWith(byteArray: ByteArray): Boolean","kotlinx.io.bytestring.endsWith"]},{"name":"fun ByteString.endsWith(byteString: ByteString): Boolean","description":"kotlinx.io.bytestring.endsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/ends-with.html","searchKeys":["endsWith","fun ByteString.endsWith(byteString: ByteString): Boolean","kotlinx.io.bytestring.endsWith"]},{"name":"fun ByteString.indexOf(byte: Byte, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.indexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html","searchKeys":["indexOf","fun ByteString.indexOf(byte: Byte, startIndex: Int = 0): Int","kotlinx.io.bytestring.indexOf"]},{"name":"fun ByteString.indexOf(byteArray: ByteArray, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.indexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html","searchKeys":["indexOf","fun ByteString.indexOf(byteArray: ByteArray, startIndex: Int = 0): Int","kotlinx.io.bytestring.indexOf"]},{"name":"fun ByteString.indexOf(byteString: ByteString, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.indexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/index-of.html","searchKeys":["indexOf","fun ByteString.indexOf(byteString: ByteString, startIndex: Int = 0): Int","kotlinx.io.bytestring.indexOf"]},{"name":"fun ByteString.isEmpty(): Boolean","description":"kotlinx.io.bytestring.isEmpty","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/is-empty.html","searchKeys":["isEmpty","fun ByteString.isEmpty(): Boolean","kotlinx.io.bytestring.isEmpty"]},{"name":"fun ByteString.isNotEmpty(): Boolean","description":"kotlinx.io.bytestring.isNotEmpty","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/is-not-empty.html","searchKeys":["isNotEmpty","fun ByteString.isNotEmpty(): Boolean","kotlinx.io.bytestring.isNotEmpty"]},{"name":"fun ByteString.lastIndexOf(byte: Byte, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.lastIndexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/last-index-of.html","searchKeys":["lastIndexOf","fun ByteString.lastIndexOf(byte: Byte, startIndex: Int = 0): Int","kotlinx.io.bytestring.lastIndexOf"]},{"name":"fun ByteString.lastIndexOf(byteArray: ByteArray, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.lastIndexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/last-index-of.html","searchKeys":["lastIndexOf","fun ByteString.lastIndexOf(byteArray: ByteArray, startIndex: Int = 0): Int","kotlinx.io.bytestring.lastIndexOf"]},{"name":"fun ByteString.lastIndexOf(byteString: ByteString, startIndex: Int = 0): Int","description":"kotlinx.io.bytestring.lastIndexOf","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/last-index-of.html","searchKeys":["lastIndexOf","fun ByteString.lastIndexOf(byteString: ByteString, startIndex: Int = 0): Int","kotlinx.io.bytestring.lastIndexOf"]},{"name":"fun ByteString.startsWith(byteArray: ByteArray): Boolean","description":"kotlinx.io.bytestring.startsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html","searchKeys":["startsWith","fun ByteString.startsWith(byteArray: ByteArray): Boolean","kotlinx.io.bytestring.startsWith"]},{"name":"fun ByteString.startsWith(byteString: ByteString): Boolean","description":"kotlinx.io.bytestring.startsWith","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/starts-with.html","searchKeys":["startsWith","fun ByteString.startsWith(byteString: ByteString): Boolean","kotlinx.io.bytestring.startsWith"]},{"name":"fun ByteString.toHexString(format: HexFormat = HexFormat.Default): String","description":"kotlinx.io.bytestring.toHexString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html","searchKeys":["toHexString","fun ByteString.toHexString(format: HexFormat = HexFormat.Default): String","kotlinx.io.bytestring.toHexString"]},{"name":"fun ByteString.toHexString(startIndex: Int = 0, endIndex: Int = size, format: HexFormat = HexFormat.Default): String","description":"kotlinx.io.bytestring.toHexString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/to-hex-string.html","searchKeys":["toHexString","fun ByteString.toHexString(startIndex: Int = 0, endIndex: Int = size, format: HexFormat = HexFormat.Default): String","kotlinx.io.bytestring.toHexString"]},{"name":"fun ByteString.toNSData(): NSData","description":"kotlinx.io.bytestring.toNSData","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/to-n-s-data.html","searchKeys":["toNSData","fun ByteString.toNSData(): NSData","kotlinx.io.bytestring.toNSData"]},{"name":"fun ByteStringBuilder.append(byte: UByte)","description":"kotlinx.io.bytestring.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/append.html","searchKeys":["append","fun ByteStringBuilder.append(byte: UByte)","kotlinx.io.bytestring.append"]},{"name":"fun ByteStringBuilder.append(byteString: ByteString)","description":"kotlinx.io.bytestring.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/append.html","searchKeys":["append","fun ByteStringBuilder.append(byteString: ByteString)","kotlinx.io.bytestring.append"]},{"name":"fun ByteStringBuilder.append(vararg bytes: Byte)","description":"kotlinx.io.bytestring.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/append.html","searchKeys":["append","fun ByteStringBuilder.append(vararg bytes: Byte)","kotlinx.io.bytestring.append"]},{"name":"fun NSData.toByteString(): ByteString","description":"kotlinx.io.bytestring.toByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/to-byte-string.html","searchKeys":["toByteString","fun NSData.toByteString(): ByteString","kotlinx.io.bytestring.toByteString"]},{"name":"fun String.encodeToByteString(): ByteString","description":"kotlinx.io.bytestring.encodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html","searchKeys":["encodeToByteString","fun String.encodeToByteString(): ByteString","kotlinx.io.bytestring.encodeToByteString"]},{"name":"fun String.encodeToByteString(charset: Charset): ByteString","description":"kotlinx.io.bytestring.encodeToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/encode-to-byte-string.html","searchKeys":["encodeToByteString","fun String.encodeToByteString(charset: Charset): ByteString","kotlinx.io.bytestring.encodeToByteString"]},{"name":"fun String.hexToByteString(format: HexFormat = HexFormat.Default): ByteString","description":"kotlinx.io.bytestring.hexToByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/hex-to-byte-string.html","searchKeys":["hexToByteString","fun String.hexToByteString(format: HexFormat = HexFormat.Default): ByteString","kotlinx.io.bytestring.hexToByteString"]},{"name":"fun append(array: ByteArray, startIndex: Int = 0, endIndex: Int = array.size)","description":"kotlinx.io.bytestring.ByteStringBuilder.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html","searchKeys":["append","fun append(array: ByteArray, startIndex: Int = 0, endIndex: Int = array.size)","kotlinx.io.bytestring.ByteStringBuilder.append"]},{"name":"fun append(byte: Byte)","description":"kotlinx.io.bytestring.ByteStringBuilder.append","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html","searchKeys":["append","fun append(byte: Byte)","kotlinx.io.bytestring.ByteStringBuilder.append"]},{"name":"fun copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size)","description":"kotlinx.io.bytestring.ByteString.copyInto","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/copy-into.html","searchKeys":["copyInto","fun copyInto(destination: ByteArray, destinationOffset: Int = 0, startIndex: Int = 0, endIndex: Int = size)","kotlinx.io.bytestring.ByteString.copyInto"]},{"name":"fun substring(startIndex: Int, endIndex: Int = size): ByteString","description":"kotlinx.io.bytestring.ByteString.substring","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/substring.html","searchKeys":["substring","fun substring(startIndex: Int, endIndex: Int = size): ByteString","kotlinx.io.bytestring.ByteString.substring"]},{"name":"fun toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray","description":"kotlinx.io.bytestring.ByteString.toByteArray","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-byte-array.html","searchKeys":["toByteArray","fun toByteArray(startIndex: Int = 0, endIndex: Int = size): ByteArray","kotlinx.io.bytestring.ByteString.toByteArray"]},{"name":"fun toByteString(): ByteString","description":"kotlinx.io.bytestring.ByteStringBuilder.toByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html","searchKeys":["toByteString","fun toByteString(): ByteString","kotlinx.io.bytestring.ByteStringBuilder.toByteString"]},{"name":"inline fun buildByteString(capacity: Int = 0, builderAction: ByteStringBuilder.() -> Unit): ByteString","description":"kotlinx.io.bytestring.buildByteString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/build-byte-string.html","searchKeys":["buildByteString","inline fun buildByteString(capacity: Int = 0, builderAction: ByteStringBuilder.() -> Unit): ByteString","kotlinx.io.bytestring.buildByteString"]},{"name":"object Companion","description":"kotlinx.io.bytestring.ByteString.Companion","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/-companion/index.html","searchKeys":["Companion","object Companion","kotlinx.io.bytestring.ByteString.Companion"]},{"name":"open operator override fun compareTo(other: ByteString): Int","description":"kotlinx.io.bytestring.ByteString.compareTo","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/compare-to.html","searchKeys":["compareTo","open operator override fun compareTo(other: ByteString): Int","kotlinx.io.bytestring.ByteString.compareTo"]},{"name":"open operator override fun equals(other: Any?): Boolean","description":"kotlinx.io.bytestring.ByteString.equals","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/equals.html","searchKeys":["equals","open operator override fun equals(other: Any?): Boolean","kotlinx.io.bytestring.ByteString.equals"]},{"name":"open override fun hashCode(): Int","description":"kotlinx.io.bytestring.ByteString.hashCode","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/hash-code.html","searchKeys":["hashCode","open override fun hashCode(): Int","kotlinx.io.bytestring.ByteString.hashCode"]},{"name":"open override fun toString(): String","description":"kotlinx.io.bytestring.ByteString.toString","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/to-string.html","searchKeys":["toString","open override fun toString(): String","kotlinx.io.bytestring.ByteString.toString"]},{"name":"operator fun get(index: Int): Byte","description":"kotlinx.io.bytestring.ByteString.get","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/get.html","searchKeys":["get","operator fun get(index: Int): Byte","kotlinx.io.bytestring.ByteString.get"]},{"name":"val ByteString.indices: IntRange","description":"kotlinx.io.bytestring.indices","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/indices.html","searchKeys":["indices","val ByteString.indices: IntRange","kotlinx.io.bytestring.indices"]},{"name":"val capacity: Int","description":"kotlinx.io.bytestring.ByteStringBuilder.capacity","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html","searchKeys":["capacity","val capacity: Int","kotlinx.io.bytestring.ByteStringBuilder.capacity"]},{"name":"val size: Int","description":"kotlinx.io.bytestring.ByteString.size","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string/size.html","searchKeys":["size","val size: Int","kotlinx.io.bytestring.ByteString.size"]},{"name":"val size: Int","description":"kotlinx.io.bytestring.ByteStringBuilder.size","location":"kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html","searchKeys":["size","val size: Int","kotlinx.io.bytestring.ByteStringBuilder.size"]},{"name":"abstract fun atomicMove(source: Path, destination: Path)","description":"kotlinx.io.files.FileSystem.atomicMove","location":"kotlinx-io-core/kotlinx.io.files/-file-system/atomic-move.html","searchKeys":["atomicMove","abstract fun atomicMove(source: Path, destination: Path)","kotlinx.io.files.FileSystem.atomicMove"]},{"name":"abstract fun createDirectories(path: Path, mustCreate: Boolean = false)","description":"kotlinx.io.files.FileSystem.createDirectories","location":"kotlinx-io-core/kotlinx.io.files/-file-system/create-directories.html","searchKeys":["createDirectories","abstract fun createDirectories(path: Path, mustCreate: Boolean = false)","kotlinx.io.files.FileSystem.createDirectories"]},{"name":"abstract fun delete(path: Path, mustExist: Boolean = true)","description":"kotlinx.io.files.FileSystem.delete","location":"kotlinx-io-core/kotlinx.io.files/-file-system/delete.html","searchKeys":["delete","abstract fun delete(path: Path, mustExist: Boolean = true)","kotlinx.io.files.FileSystem.delete"]},{"name":"abstract fun emit()","description":"kotlinx.io.Sink.emit","location":"kotlinx-io-core/kotlinx.io/-sink/emit.html","searchKeys":["emit","abstract fun emit()","kotlinx.io.Sink.emit"]},{"name":"abstract fun exhausted(): Boolean","description":"kotlinx.io.Source.exhausted","location":"kotlinx-io-core/kotlinx.io/-source/exhausted.html","searchKeys":["exhausted","abstract fun exhausted(): Boolean","kotlinx.io.Source.exhausted"]},{"name":"abstract fun exists(path: Path): Boolean","description":"kotlinx.io.files.FileSystem.exists","location":"kotlinx-io-core/kotlinx.io.files/-file-system/exists.html","searchKeys":["exists","abstract fun exists(path: Path): Boolean","kotlinx.io.files.FileSystem.exists"]},{"name":"abstract fun hintEmit()","description":"kotlinx.io.Sink.hintEmit","location":"kotlinx-io-core/kotlinx.io/-sink/hint-emit.html","searchKeys":["hintEmit","abstract fun hintEmit()","kotlinx.io.Sink.hintEmit"]},{"name":"abstract fun list(directory: Path): Collection","description":"kotlinx.io.files.FileSystem.list","location":"kotlinx-io-core/kotlinx.io.files/-file-system/list.html","searchKeys":["list","abstract fun list(directory: Path): Collection","kotlinx.io.files.FileSystem.list"]},{"name":"abstract fun metadataOrNull(path: Path): FileMetadata?","description":"kotlinx.io.files.FileSystem.metadataOrNull","location":"kotlinx-io-core/kotlinx.io.files/-file-system/metadata-or-null.html","searchKeys":["metadataOrNull","abstract fun metadataOrNull(path: Path): FileMetadata?","kotlinx.io.files.FileSystem.metadataOrNull"]},{"name":"abstract fun peek(): Source","description":"kotlinx.io.Source.peek","location":"kotlinx-io-core/kotlinx.io/-source/peek.html","searchKeys":["peek","abstract fun peek(): Source","kotlinx.io.Source.peek"]},{"name":"abstract fun readAtMostTo(sink: Buffer, byteCount: Long): Long","description":"kotlinx.io.RawSource.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-raw-source/read-at-most-to.html","searchKeys":["readAtMostTo","abstract fun readAtMostTo(sink: Buffer, byteCount: Long): Long","kotlinx.io.RawSource.readAtMostTo"]},{"name":"abstract fun readAtMostTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size): Int","description":"kotlinx.io.Source.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-source/read-at-most-to.html","searchKeys":["readAtMostTo","abstract fun readAtMostTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size): Int","kotlinx.io.Source.readAtMostTo"]},{"name":"abstract fun readByte(): Byte","description":"kotlinx.io.Source.readByte","location":"kotlinx-io-core/kotlinx.io/-source/read-byte.html","searchKeys":["readByte","abstract fun readByte(): Byte","kotlinx.io.Source.readByte"]},{"name":"abstract fun readInt(): Int","description":"kotlinx.io.Source.readInt","location":"kotlinx-io-core/kotlinx.io/-source/read-int.html","searchKeys":["readInt","abstract fun readInt(): Int","kotlinx.io.Source.readInt"]},{"name":"abstract fun readLong(): Long","description":"kotlinx.io.Source.readLong","location":"kotlinx-io-core/kotlinx.io/-source/read-long.html","searchKeys":["readLong","abstract fun readLong(): Long","kotlinx.io.Source.readLong"]},{"name":"abstract fun readShort(): Short","description":"kotlinx.io.Source.readShort","location":"kotlinx-io-core/kotlinx.io/-source/read-short.html","searchKeys":["readShort","abstract fun readShort(): Short","kotlinx.io.Source.readShort"]},{"name":"abstract fun readTo(sink: RawSink, byteCount: Long)","description":"kotlinx.io.Source.readTo","location":"kotlinx-io-core/kotlinx.io/-source/read-to.html","searchKeys":["readTo","abstract fun readTo(sink: RawSink, byteCount: Long)","kotlinx.io.Source.readTo"]},{"name":"abstract fun request(byteCount: Long): Boolean","description":"kotlinx.io.Source.request","location":"kotlinx-io-core/kotlinx.io/-source/request.html","searchKeys":["request","abstract fun request(byteCount: Long): Boolean","kotlinx.io.Source.request"]},{"name":"abstract fun require(byteCount: Long)","description":"kotlinx.io.Source.require","location":"kotlinx-io-core/kotlinx.io/-source/require.html","searchKeys":["require","abstract fun require(byteCount: Long)","kotlinx.io.Source.require"]},{"name":"abstract fun resolve(path: Path): Path","description":"kotlinx.io.files.FileSystem.resolve","location":"kotlinx-io-core/kotlinx.io.files/-file-system/resolve.html","searchKeys":["resolve","abstract fun resolve(path: Path): Path","kotlinx.io.files.FileSystem.resolve"]},{"name":"abstract fun sink(path: Path, append: Boolean = false): RawSink","description":"kotlinx.io.files.FileSystem.sink","location":"kotlinx-io-core/kotlinx.io.files/-file-system/sink.html","searchKeys":["sink","abstract fun sink(path: Path, append: Boolean = false): RawSink","kotlinx.io.files.FileSystem.sink"]},{"name":"abstract fun skip(byteCount: Long)","description":"kotlinx.io.Source.skip","location":"kotlinx-io-core/kotlinx.io/-source/skip.html","searchKeys":["skip","abstract fun skip(byteCount: Long)","kotlinx.io.Source.skip"]},{"name":"abstract fun source(path: Path): RawSource","description":"kotlinx.io.files.FileSystem.source","location":"kotlinx-io-core/kotlinx.io.files/-file-system/source.html","searchKeys":["source","abstract fun source(path: Path): RawSource","kotlinx.io.files.FileSystem.source"]},{"name":"abstract fun transferFrom(source: RawSource): Long","description":"kotlinx.io.Sink.transferFrom","location":"kotlinx-io-core/kotlinx.io/-sink/transfer-from.html","searchKeys":["transferFrom","abstract fun transferFrom(source: RawSource): Long","kotlinx.io.Sink.transferFrom"]},{"name":"abstract fun transferTo(sink: RawSink): Long","description":"kotlinx.io.Source.transferTo","location":"kotlinx-io-core/kotlinx.io/-source/transfer-to.html","searchKeys":["transferTo","abstract fun transferTo(sink: RawSink): Long","kotlinx.io.Source.transferTo"]},{"name":"abstract fun write(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size)","description":"kotlinx.io.Sink.write","location":"kotlinx-io-core/kotlinx.io/-sink/write.html","searchKeys":["write","abstract fun write(source: ByteArray, startIndex: Int = 0, endIndex: Int = source.size)","kotlinx.io.Sink.write"]},{"name":"abstract fun write(source: RawSource, byteCount: Long)","description":"kotlinx.io.Sink.write","location":"kotlinx-io-core/kotlinx.io/-sink/write.html","searchKeys":["write","abstract fun write(source: RawSource, byteCount: Long)","kotlinx.io.Sink.write"]},{"name":"abstract fun writeByte(byte: Byte)","description":"kotlinx.io.Sink.writeByte","location":"kotlinx-io-core/kotlinx.io/-sink/write-byte.html","searchKeys":["writeByte","abstract fun writeByte(byte: Byte)","kotlinx.io.Sink.writeByte"]},{"name":"abstract fun writeInt(int: Int)","description":"kotlinx.io.Sink.writeInt","location":"kotlinx-io-core/kotlinx.io/-sink/write-int.html","searchKeys":["writeInt","abstract fun writeInt(int: Int)","kotlinx.io.Sink.writeInt"]},{"name":"abstract fun writeLong(long: Long)","description":"kotlinx.io.Sink.writeLong","location":"kotlinx-io-core/kotlinx.io/-sink/write-long.html","searchKeys":["writeLong","abstract fun writeLong(long: Long)","kotlinx.io.Sink.writeLong"]},{"name":"abstract fun writeShort(short: Short)","description":"kotlinx.io.Sink.writeShort","location":"kotlinx-io-core/kotlinx.io/-sink/write-short.html","searchKeys":["writeShort","abstract fun writeShort(short: Short)","kotlinx.io.Sink.writeShort"]},{"name":"abstract override fun close()","description":"kotlinx.io.RawSource.close","location":"kotlinx-io-core/kotlinx.io/-raw-source/close.html","searchKeys":["close","abstract override fun close()","kotlinx.io.RawSource.close"]},{"name":"abstract override fun flush()","description":"kotlinx.io.Sink.flush","location":"kotlinx-io-core/kotlinx.io/-sink/flush.html","searchKeys":["flush","abstract override fun flush()","kotlinx.io.Sink.flush"]},{"name":"abstract val buffer: Buffer","description":"kotlinx.io.Sink.buffer","location":"kotlinx-io-core/kotlinx.io/-sink/buffer.html","searchKeys":["buffer","abstract val buffer: Buffer","kotlinx.io.Sink.buffer"]},{"name":"abstract val buffer: Buffer","description":"kotlinx.io.Source.buffer","location":"kotlinx-io-core/kotlinx.io/-source/buffer.html","searchKeys":["buffer","abstract val buffer: Buffer","kotlinx.io.Source.buffer"]},{"name":"annotation class DelicateIoApi","description":"kotlinx.io.DelicateIoApi","location":"kotlinx-io-core/kotlinx.io/-delicate-io-api/index.html","searchKeys":["DelicateIoApi","annotation class DelicateIoApi","kotlinx.io.DelicateIoApi"]},{"name":"annotation class InternalIoApi","description":"kotlinx.io.InternalIoApi","location":"kotlinx-io-core/kotlinx.io/-internal-io-api/index.html","searchKeys":["InternalIoApi","annotation class InternalIoApi","kotlinx.io.InternalIoApi"]},{"name":"annotation class UnsafeIoApi","description":"kotlinx.io.UnsafeIoApi","location":"kotlinx-io-core/kotlinx.io/-unsafe-io-api/index.html","searchKeys":["UnsafeIoApi","annotation class UnsafeIoApi","kotlinx.io.UnsafeIoApi"]},{"name":"class Buffer : Source, Sink","description":"kotlinx.io.Buffer","location":"kotlinx-io-core/kotlinx.io/-buffer/index.html","searchKeys":["Buffer","class Buffer : Source, Sink","kotlinx.io.Buffer"]},{"name":"class FileMetadata(val isRegularFile: Boolean = false, val isDirectory: Boolean = false, val size: Long = 0)","description":"kotlinx.io.files.FileMetadata","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/index.html","searchKeys":["FileMetadata","class FileMetadata(val isRegularFile: Boolean = false, val isDirectory: Boolean = false, val size: Long = 0)","kotlinx.io.files.FileMetadata"]},{"name":"class Segment","description":"kotlinx.io.Segment","location":"kotlinx-io-core/kotlinx.io/-segment/index.html","searchKeys":["Segment","class Segment","kotlinx.io.Segment"]},{"name":"constructor()","description":"kotlinx.io.Buffer.Buffer","location":"kotlinx-io-core/kotlinx.io/-buffer/-buffer.html","searchKeys":["Buffer","constructor()","kotlinx.io.Buffer.Buffer"]},{"name":"constructor(isRegularFile: Boolean = false, isDirectory: Boolean = false, size: Long = 0)","description":"kotlinx.io.files.FileMetadata.FileMetadata","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/-file-metadata.html","searchKeys":["FileMetadata","constructor(isRegularFile: Boolean = false, isDirectory: Boolean = false, size: Long = 0)","kotlinx.io.files.FileMetadata.FileMetadata"]},{"name":"expect abstract fun flush()","description":"kotlinx.io.RawSink.flush","location":"kotlinx-io-core/kotlinx.io/-raw-sink/flush.html","searchKeys":["flush","expect abstract fun flush()","kotlinx.io.RawSink.flush"]},{"name":"expect abstract fun write(source: Buffer, byteCount: Long)","description":"kotlinx.io.RawSink.write","location":"kotlinx-io-core/kotlinx.io/-raw-sink/write.html","searchKeys":["write","expect abstract fun write(source: Buffer, byteCount: Long)","kotlinx.io.RawSink.write"]},{"name":"expect abstract override fun close()","description":"kotlinx.io.RawSink.close","location":"kotlinx-io-core/kotlinx.io/-raw-sink/close.html","searchKeys":["close","expect abstract override fun close()","kotlinx.io.RawSink.close"]},{"name":"expect class FileNotFoundException(message: String?) : IOException","description":"kotlinx.io.files.FileNotFoundException","location":"kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/index.html","searchKeys":["FileNotFoundException","expect class FileNotFoundException(message: String?) : IOException","kotlinx.io.files.FileNotFoundException"]},{"name":"expect class Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path/index.html","searchKeys":["Path","expect class Path","kotlinx.io.files.Path"]},{"name":"expect constructor()","description":"kotlinx.io.EOFException.EOFException","location":"kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html","searchKeys":["EOFException","expect constructor()","kotlinx.io.EOFException.EOFException"]},{"name":"expect constructor()","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor()","kotlinx.io.IOException.IOException"]},{"name":"expect constructor(cause: Throwable?)","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor(cause: Throwable?)","kotlinx.io.IOException.IOException"]},{"name":"expect constructor(message: String?)","description":"kotlinx.io.EOFException.EOFException","location":"kotlinx-io-core/kotlinx.io/-e-o-f-exception/-e-o-f-exception.html","searchKeys":["EOFException","expect constructor(message: String?)","kotlinx.io.EOFException.EOFException"]},{"name":"expect constructor(message: String?)","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor(message: String?)","kotlinx.io.IOException.IOException"]},{"name":"expect constructor(message: String?)","description":"kotlinx.io.files.FileNotFoundException.FileNotFoundException","location":"kotlinx-io-core/kotlinx.io.files/-file-not-found-exception/-file-not-found-exception.html","searchKeys":["FileNotFoundException","expect constructor(message: String?)","kotlinx.io.files.FileNotFoundException.FileNotFoundException"]},{"name":"expect constructor(message: String?, cause: Throwable?)","description":"kotlinx.io.IOException.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/-i-o-exception.html","searchKeys":["IOException","expect constructor(message: String?, cause: Throwable?)","kotlinx.io.IOException.IOException"]},{"name":"expect fun Path(path: String): Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path.html","searchKeys":["Path","expect fun Path(path: String): Path","kotlinx.io.files.Path"]},{"name":"expect interface RawSink : AutoCloseable","description":"kotlinx.io.RawSink","location":"kotlinx-io-core/kotlinx.io/-raw-sink/index.html","searchKeys":["RawSink","expect interface RawSink : AutoCloseable","kotlinx.io.RawSink"]},{"name":"expect open class EOFException : IOException","description":"kotlinx.io.EOFException","location":"kotlinx-io-core/kotlinx.io/-e-o-f-exception/index.html","searchKeys":["EOFException","expect open class EOFException : IOException","kotlinx.io.EOFException"]},{"name":"expect open class IOException : Exception","description":"kotlinx.io.IOException","location":"kotlinx-io-core/kotlinx.io/-i-o-exception/index.html","searchKeys":["IOException","expect open class IOException : Exception","kotlinx.io.IOException"]},{"name":"expect open operator override fun equals(other: Any?): Boolean","description":"kotlinx.io.files.Path.equals","location":"kotlinx-io-core/kotlinx.io.files/-path/equals.html","searchKeys":["equals","expect open operator override fun equals(other: Any?): Boolean","kotlinx.io.files.Path.equals"]},{"name":"expect open override fun hashCode(): Int","description":"kotlinx.io.files.Path.hashCode","location":"kotlinx-io-core/kotlinx.io.files/-path/hash-code.html","searchKeys":["hashCode","expect open override fun hashCode(): Int","kotlinx.io.files.Path.hashCode"]},{"name":"expect open override fun toString(): String","description":"kotlinx.io.files.Path.toString","location":"kotlinx-io-core/kotlinx.io.files/-path/to-string.html","searchKeys":["toString","expect open override fun toString(): String","kotlinx.io.files.Path.toString"]},{"name":"expect val SystemFileSystem: FileSystem","description":"kotlinx.io.files.SystemFileSystem","location":"kotlinx-io-core/kotlinx.io.files/-system-file-system.html","searchKeys":["SystemFileSystem","expect val SystemFileSystem: FileSystem","kotlinx.io.files.SystemFileSystem"]},{"name":"expect val SystemPathSeparator: Char","description":"kotlinx.io.files.SystemPathSeparator","location":"kotlinx-io-core/kotlinx.io.files/-system-path-separator.html","searchKeys":["SystemPathSeparator","expect val SystemPathSeparator: Char","kotlinx.io.files.SystemPathSeparator"]},{"name":"expect val SystemTemporaryDirectory: Path","description":"kotlinx.io.files.SystemTemporaryDirectory","location":"kotlinx-io-core/kotlinx.io.files/-system-temporary-directory.html","searchKeys":["SystemTemporaryDirectory","expect val SystemTemporaryDirectory: Path","kotlinx.io.files.SystemTemporaryDirectory"]},{"name":"expect val isAbsolute: Boolean","description":"kotlinx.io.files.Path.isAbsolute","location":"kotlinx-io-core/kotlinx.io.files/-path/is-absolute.html","searchKeys":["isAbsolute","expect val isAbsolute: Boolean","kotlinx.io.files.Path.isAbsolute"]},{"name":"expect val name: String","description":"kotlinx.io.files.Path.name","location":"kotlinx-io-core/kotlinx.io.files/-path/name.html","searchKeys":["name","expect val name: String","kotlinx.io.files.Path.name"]},{"name":"expect val parent: Path?","description":"kotlinx.io.files.Path.parent","location":"kotlinx-io-core/kotlinx.io.files/-path/parent.html","searchKeys":["parent","expect val parent: Path?","kotlinx.io.files.Path.parent"]},{"name":"fun Buffer.asByteChannel(): ByteChannel","description":"kotlinx.io.asByteChannel","location":"kotlinx-io-core/kotlinx.io/as-byte-channel.html","searchKeys":["asByteChannel","fun Buffer.asByteChannel(): ByteChannel","kotlinx.io.asByteChannel"]},{"name":"fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)","description":"kotlinx.io.copyTo","location":"kotlinx-io-core/kotlinx.io/copy-to.html","searchKeys":["copyTo","fun Buffer.copyTo(out: OutputStream, startIndex: Long = 0, endIndex: Long = size)","kotlinx.io.copyTo"]},{"name":"fun Buffer.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = size): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Buffer.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = size): Long","kotlinx.io.indexOf"]},{"name":"fun Buffer.indexOf(byteString: ByteString, startIndex: Long = 0): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Buffer.indexOf(byteString: ByteString, startIndex: Long = 0): Long","kotlinx.io.indexOf"]},{"name":"fun Buffer.readAtMostTo(sink: ByteBuffer): Int","description":"kotlinx.io.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/read-at-most-to.html","searchKeys":["readAtMostTo","fun Buffer.readAtMostTo(sink: ByteBuffer): Int","kotlinx.io.readAtMostTo"]},{"name":"fun Buffer.readString(): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Buffer.readString(): String","kotlinx.io.readString"]},{"name":"fun Buffer.readTo(out: OutputStream, byteCount: Long = size)","description":"kotlinx.io.readTo","location":"kotlinx-io-core/kotlinx.io/read-to.html","searchKeys":["readTo","fun Buffer.readTo(out: OutputStream, byteCount: Long = size)","kotlinx.io.readTo"]},{"name":"fun Buffer.snapshot(): ByteString","description":"kotlinx.io.snapshot","location":"kotlinx-io-core/kotlinx.io/snapshot.html","searchKeys":["snapshot","fun Buffer.snapshot(): ByteString","kotlinx.io.snapshot"]},{"name":"fun Buffer.transferFrom(input: InputStream): Buffer","description":"kotlinx.io.transferFrom","location":"kotlinx-io-core/kotlinx.io/transfer-from.html","searchKeys":["transferFrom","fun Buffer.transferFrom(input: InputStream): Buffer","kotlinx.io.transferFrom"]},{"name":"fun Buffer.transferFrom(source: ByteBuffer): Buffer","description":"kotlinx.io.transferFrom","location":"kotlinx-io-core/kotlinx.io/transfer-from.html","searchKeys":["transferFrom","fun Buffer.transferFrom(source: ByteBuffer): Buffer","kotlinx.io.transferFrom"]},{"name":"fun Buffer.write(input: InputStream, byteCount: Long): Buffer","description":"kotlinx.io.write","location":"kotlinx-io-core/kotlinx.io/write.html","searchKeys":["write","fun Buffer.write(input: InputStream, byteCount: Long): Buffer","kotlinx.io.write"]},{"name":"fun InputStream.asSource(): RawSource","description":"kotlinx.io.asSource","location":"kotlinx-io-core/kotlinx.io/as-source.html","searchKeys":["asSource","fun InputStream.asSource(): RawSource","kotlinx.io.asSource"]},{"name":"fun NSInputStream.asSource(): RawSource","description":"kotlinx.io.asSource","location":"kotlinx-io-core/kotlinx.io/as-source.html","searchKeys":["asSource","fun NSInputStream.asSource(): RawSource","kotlinx.io.asSource"]},{"name":"fun NSOutputStream.asSink(): RawSink","description":"kotlinx.io.asSink","location":"kotlinx-io-core/kotlinx.io/as-sink.html","searchKeys":["asSink","fun NSOutputStream.asSink(): RawSink","kotlinx.io.asSink"]},{"name":"fun OutputStream.asSink(): RawSink","description":"kotlinx.io.asSink","location":"kotlinx-io-core/kotlinx.io/as-sink.html","searchKeys":["asSink","fun OutputStream.asSink(): RawSink","kotlinx.io.asSink"]},{"name":"fun Path(base: Path, vararg parts: String): Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path.html","searchKeys":["Path","fun Path(base: Path, vararg parts: String): Path","kotlinx.io.files.Path"]},{"name":"fun Path(base: String, vararg parts: String): Path","description":"kotlinx.io.files.Path","location":"kotlinx-io-core/kotlinx.io.files/-path.html","searchKeys":["Path","fun Path(base: String, vararg parts: String): Path","kotlinx.io.files.Path"]},{"name":"fun Path.sink(): Sink","description":"kotlinx.io.files.sink","location":"kotlinx-io-core/kotlinx.io.files/sink.html","searchKeys":["sink","fun Path.sink(): Sink","kotlinx.io.files.sink"]},{"name":"fun Path.source(): Source","description":"kotlinx.io.files.source","location":"kotlinx-io-core/kotlinx.io.files/source.html","searchKeys":["source","fun Path.source(): Source","kotlinx.io.files.source"]},{"name":"fun RawSink.buffered(): Sink","description":"kotlinx.io.buffered","location":"kotlinx-io-core/kotlinx.io/buffered.html","searchKeys":["buffered","fun RawSink.buffered(): Sink","kotlinx.io.buffered"]},{"name":"fun RawSource.buffered(): Source","description":"kotlinx.io.buffered","location":"kotlinx-io-core/kotlinx.io/buffered.html","searchKeys":["buffered","fun RawSource.buffered(): Source","kotlinx.io.buffered"]},{"name":"fun Sink.asByteChannel(): WritableByteChannel","description":"kotlinx.io.asByteChannel","location":"kotlinx-io-core/kotlinx.io/as-byte-channel.html","searchKeys":["asByteChannel","fun Sink.asByteChannel(): WritableByteChannel","kotlinx.io.asByteChannel"]},{"name":"fun Sink.asNSOutputStream(): NSOutputStream","description":"kotlinx.io.asNSOutputStream","location":"kotlinx-io-core/kotlinx.io/as-n-s-output-stream.html","searchKeys":["asNSOutputStream","fun Sink.asNSOutputStream(): NSOutputStream","kotlinx.io.asNSOutputStream"]},{"name":"fun Sink.asOutputStream(): OutputStream","description":"kotlinx.io.asOutputStream","location":"kotlinx-io-core/kotlinx.io/as-output-stream.html","searchKeys":["asOutputStream","fun Sink.asOutputStream(): OutputStream","kotlinx.io.asOutputStream"]},{"name":"fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)","description":"kotlinx.io.write","location":"kotlinx-io-core/kotlinx.io/write.html","searchKeys":["write","fun Sink.write(byteString: ByteString, startIndex: Int = 0, endIndex: Int = byteString.size)","kotlinx.io.write"]},{"name":"fun Sink.write(source: ByteBuffer): Int","description":"kotlinx.io.write","location":"kotlinx-io-core/kotlinx.io/write.html","searchKeys":["write","fun Sink.write(source: ByteBuffer): Int","kotlinx.io.write"]},{"name":"fun Sink.writeCodePointValue(codePoint: Int)","description":"kotlinx.io.writeCodePointValue","location":"kotlinx-io-core/kotlinx.io/write-code-point-value.html","searchKeys":["writeCodePointValue","fun Sink.writeCodePointValue(codePoint: Int)","kotlinx.io.writeCodePointValue"]},{"name":"fun Sink.writeDecimalLong(long: Long)","description":"kotlinx.io.writeDecimalLong","location":"kotlinx-io-core/kotlinx.io/write-decimal-long.html","searchKeys":["writeDecimalLong","fun Sink.writeDecimalLong(long: Long)","kotlinx.io.writeDecimalLong"]},{"name":"fun Sink.writeDouble(double: Double)","description":"kotlinx.io.writeDouble","location":"kotlinx-io-core/kotlinx.io/write-double.html","searchKeys":["writeDouble","fun Sink.writeDouble(double: Double)","kotlinx.io.writeDouble"]},{"name":"fun Sink.writeDoubleLe(double: Double)","description":"kotlinx.io.writeDoubleLe","location":"kotlinx-io-core/kotlinx.io/write-double-le.html","searchKeys":["writeDoubleLe","fun Sink.writeDoubleLe(double: Double)","kotlinx.io.writeDoubleLe"]},{"name":"fun Sink.writeFloat(float: Float)","description":"kotlinx.io.writeFloat","location":"kotlinx-io-core/kotlinx.io/write-float.html","searchKeys":["writeFloat","fun Sink.writeFloat(float: Float)","kotlinx.io.writeFloat"]},{"name":"fun Sink.writeFloatLe(float: Float)","description":"kotlinx.io.writeFloatLe","location":"kotlinx-io-core/kotlinx.io/write-float-le.html","searchKeys":["writeFloatLe","fun Sink.writeFloatLe(float: Float)","kotlinx.io.writeFloatLe"]},{"name":"fun Sink.writeHexadecimalUnsignedLong(long: Long)","description":"kotlinx.io.writeHexadecimalUnsignedLong","location":"kotlinx-io-core/kotlinx.io/write-hexadecimal-unsigned-long.html","searchKeys":["writeHexadecimalUnsignedLong","fun Sink.writeHexadecimalUnsignedLong(long: Long)","kotlinx.io.writeHexadecimalUnsignedLong"]},{"name":"fun Sink.writeIntLe(int: Int)","description":"kotlinx.io.writeIntLe","location":"kotlinx-io-core/kotlinx.io/write-int-le.html","searchKeys":["writeIntLe","fun Sink.writeIntLe(int: Int)","kotlinx.io.writeIntLe"]},{"name":"fun Sink.writeLongLe(long: Long)","description":"kotlinx.io.writeLongLe","location":"kotlinx-io-core/kotlinx.io/write-long-le.html","searchKeys":["writeLongLe","fun Sink.writeLongLe(long: Long)","kotlinx.io.writeLongLe"]},{"name":"fun Sink.writeShortLe(short: Short)","description":"kotlinx.io.writeShortLe","location":"kotlinx-io-core/kotlinx.io/write-short-le.html","searchKeys":["writeShortLe","fun Sink.writeShortLe(short: Short)","kotlinx.io.writeShortLe"]},{"name":"fun Sink.writeString(chars: CharSequence, startIndex: Int = 0, endIndex: Int = chars.length)","description":"kotlinx.io.writeString","location":"kotlinx-io-core/kotlinx.io/write-string.html","searchKeys":["writeString","fun Sink.writeString(chars: CharSequence, startIndex: Int = 0, endIndex: Int = chars.length)","kotlinx.io.writeString"]},{"name":"fun Sink.writeString(string: String, charset: Charset, startIndex: Int = 0, endIndex: Int = string.length)","description":"kotlinx.io.writeString","location":"kotlinx-io-core/kotlinx.io/write-string.html","searchKeys":["writeString","fun Sink.writeString(string: String, charset: Charset, startIndex: Int = 0, endIndex: Int = string.length)","kotlinx.io.writeString"]},{"name":"fun Sink.writeString(string: String, startIndex: Int = 0, endIndex: Int = string.length)","description":"kotlinx.io.writeString","location":"kotlinx-io-core/kotlinx.io/write-string.html","searchKeys":["writeString","fun Sink.writeString(string: String, startIndex: Int = 0, endIndex: Int = string.length)","kotlinx.io.writeString"]},{"name":"fun Sink.writeUByte(byte: UByte)","description":"kotlinx.io.writeUByte","location":"kotlinx-io-core/kotlinx.io/write-u-byte.html","searchKeys":["writeUByte","fun Sink.writeUByte(byte: UByte)","kotlinx.io.writeUByte"]},{"name":"fun Sink.writeUInt(int: UInt)","description":"kotlinx.io.writeUInt","location":"kotlinx-io-core/kotlinx.io/write-u-int.html","searchKeys":["writeUInt","fun Sink.writeUInt(int: UInt)","kotlinx.io.writeUInt"]},{"name":"fun Sink.writeUIntLe(int: UInt)","description":"kotlinx.io.writeUIntLe","location":"kotlinx-io-core/kotlinx.io/write-u-int-le.html","searchKeys":["writeUIntLe","fun Sink.writeUIntLe(int: UInt)","kotlinx.io.writeUIntLe"]},{"name":"fun Sink.writeULong(long: ULong)","description":"kotlinx.io.writeULong","location":"kotlinx-io-core/kotlinx.io/write-u-long.html","searchKeys":["writeULong","fun Sink.writeULong(long: ULong)","kotlinx.io.writeULong"]},{"name":"fun Sink.writeULongLe(long: ULong)","description":"kotlinx.io.writeULongLe","location":"kotlinx-io-core/kotlinx.io/write-u-long-le.html","searchKeys":["writeULongLe","fun Sink.writeULongLe(long: ULong)","kotlinx.io.writeULongLe"]},{"name":"fun Sink.writeUShort(short: UShort)","description":"kotlinx.io.writeUShort","location":"kotlinx-io-core/kotlinx.io/write-u-short.html","searchKeys":["writeUShort","fun Sink.writeUShort(short: UShort)","kotlinx.io.writeUShort"]},{"name":"fun Sink.writeUShortLe(short: UShort)","description":"kotlinx.io.writeUShortLe","location":"kotlinx-io-core/kotlinx.io/write-u-short-le.html","searchKeys":["writeUShortLe","fun Sink.writeUShortLe(short: UShort)","kotlinx.io.writeUShortLe"]},{"name":"fun Source.asByteChannel(): ReadableByteChannel","description":"kotlinx.io.asByteChannel","location":"kotlinx-io-core/kotlinx.io/as-byte-channel.html","searchKeys":["asByteChannel","fun Source.asByteChannel(): ReadableByteChannel","kotlinx.io.asByteChannel"]},{"name":"fun Source.asInputStream(): InputStream","description":"kotlinx.io.asInputStream","location":"kotlinx-io-core/kotlinx.io/as-input-stream.html","searchKeys":["asInputStream","fun Source.asInputStream(): InputStream","kotlinx.io.asInputStream"]},{"name":"fun Source.asNSInputStream(): NSInputStream","description":"kotlinx.io.asNSInputStream","location":"kotlinx-io-core/kotlinx.io/as-n-s-input-stream.html","searchKeys":["asNSInputStream","fun Source.asNSInputStream(): NSInputStream","kotlinx.io.asNSInputStream"]},{"name":"fun Source.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = Long.MAX_VALUE): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Source.indexOf(byte: Byte, startIndex: Long = 0, endIndex: Long = Long.MAX_VALUE): Long","kotlinx.io.indexOf"]},{"name":"fun Source.indexOf(byteString: ByteString, startIndex: Long = 0): Long","description":"kotlinx.io.indexOf","location":"kotlinx-io-core/kotlinx.io/index-of.html","searchKeys":["indexOf","fun Source.indexOf(byteString: ByteString, startIndex: Long = 0): Long","kotlinx.io.indexOf"]},{"name":"fun Source.readAtMostTo(sink: ByteBuffer): Int","description":"kotlinx.io.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/read-at-most-to.html","searchKeys":["readAtMostTo","fun Source.readAtMostTo(sink: ByteBuffer): Int","kotlinx.io.readAtMostTo"]},{"name":"fun Source.readByteArray(): ByteArray","description":"kotlinx.io.readByteArray","location":"kotlinx-io-core/kotlinx.io/read-byte-array.html","searchKeys":["readByteArray","fun Source.readByteArray(): ByteArray","kotlinx.io.readByteArray"]},{"name":"fun Source.readByteArray(byteCount: Int): ByteArray","description":"kotlinx.io.readByteArray","location":"kotlinx-io-core/kotlinx.io/read-byte-array.html","searchKeys":["readByteArray","fun Source.readByteArray(byteCount: Int): ByteArray","kotlinx.io.readByteArray"]},{"name":"fun Source.readByteString(): ByteString","description":"kotlinx.io.readByteString","location":"kotlinx-io-core/kotlinx.io/read-byte-string.html","searchKeys":["readByteString","fun Source.readByteString(): ByteString","kotlinx.io.readByteString"]},{"name":"fun Source.readByteString(byteCount: Int): ByteString","description":"kotlinx.io.readByteString","location":"kotlinx-io-core/kotlinx.io/read-byte-string.html","searchKeys":["readByteString","fun Source.readByteString(byteCount: Int): ByteString","kotlinx.io.readByteString"]},{"name":"fun Source.readCodePointValue(): Int","description":"kotlinx.io.readCodePointValue","location":"kotlinx-io-core/kotlinx.io/read-code-point-value.html","searchKeys":["readCodePointValue","fun Source.readCodePointValue(): Int","kotlinx.io.readCodePointValue"]},{"name":"fun Source.readDecimalLong(): Long","description":"kotlinx.io.readDecimalLong","location":"kotlinx-io-core/kotlinx.io/read-decimal-long.html","searchKeys":["readDecimalLong","fun Source.readDecimalLong(): Long","kotlinx.io.readDecimalLong"]},{"name":"fun Source.readDouble(): Double","description":"kotlinx.io.readDouble","location":"kotlinx-io-core/kotlinx.io/read-double.html","searchKeys":["readDouble","fun Source.readDouble(): Double","kotlinx.io.readDouble"]},{"name":"fun Source.readDoubleLe(): Double","description":"kotlinx.io.readDoubleLe","location":"kotlinx-io-core/kotlinx.io/read-double-le.html","searchKeys":["readDoubleLe","fun Source.readDoubleLe(): Double","kotlinx.io.readDoubleLe"]},{"name":"fun Source.readFloat(): Float","description":"kotlinx.io.readFloat","location":"kotlinx-io-core/kotlinx.io/read-float.html","searchKeys":["readFloat","fun Source.readFloat(): Float","kotlinx.io.readFloat"]},{"name":"fun Source.readFloatLe(): Float","description":"kotlinx.io.readFloatLe","location":"kotlinx-io-core/kotlinx.io/read-float-le.html","searchKeys":["readFloatLe","fun Source.readFloatLe(): Float","kotlinx.io.readFloatLe"]},{"name":"fun Source.readHexadecimalUnsignedLong(): Long","description":"kotlinx.io.readHexadecimalUnsignedLong","location":"kotlinx-io-core/kotlinx.io/read-hexadecimal-unsigned-long.html","searchKeys":["readHexadecimalUnsignedLong","fun Source.readHexadecimalUnsignedLong(): Long","kotlinx.io.readHexadecimalUnsignedLong"]},{"name":"fun Source.readIntLe(): Int","description":"kotlinx.io.readIntLe","location":"kotlinx-io-core/kotlinx.io/read-int-le.html","searchKeys":["readIntLe","fun Source.readIntLe(): Int","kotlinx.io.readIntLe"]},{"name":"fun Source.readLine(): String?","description":"kotlinx.io.readLine","location":"kotlinx-io-core/kotlinx.io/read-line.html","searchKeys":["readLine","fun Source.readLine(): String?","kotlinx.io.readLine"]},{"name":"fun Source.readLineStrict(limit: Long = Long.MAX_VALUE): String","description":"kotlinx.io.readLineStrict","location":"kotlinx-io-core/kotlinx.io/read-line-strict.html","searchKeys":["readLineStrict","fun Source.readLineStrict(limit: Long = Long.MAX_VALUE): String","kotlinx.io.readLineStrict"]},{"name":"fun Source.readLongLe(): Long","description":"kotlinx.io.readLongLe","location":"kotlinx-io-core/kotlinx.io/read-long-le.html","searchKeys":["readLongLe","fun Source.readLongLe(): Long","kotlinx.io.readLongLe"]},{"name":"fun Source.readShortLe(): Short","description":"kotlinx.io.readShortLe","location":"kotlinx-io-core/kotlinx.io/read-short-le.html","searchKeys":["readShortLe","fun Source.readShortLe(): Short","kotlinx.io.readShortLe"]},{"name":"fun Source.readString(): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(): String","kotlinx.io.readString"]},{"name":"fun Source.readString(byteCount: Long): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(byteCount: Long): String","kotlinx.io.readString"]},{"name":"fun Source.readString(byteCount: Long, charset: Charset): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(byteCount: Long, charset: Charset): String","kotlinx.io.readString"]},{"name":"fun Source.readString(charset: Charset): String","description":"kotlinx.io.readString","location":"kotlinx-io-core/kotlinx.io/read-string.html","searchKeys":["readString","fun Source.readString(charset: Charset): String","kotlinx.io.readString"]},{"name":"fun Source.readTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size)","description":"kotlinx.io.readTo","location":"kotlinx-io-core/kotlinx.io/read-to.html","searchKeys":["readTo","fun Source.readTo(sink: ByteArray, startIndex: Int = 0, endIndex: Int = sink.size)","kotlinx.io.readTo"]},{"name":"fun Source.readUByte(): UByte","description":"kotlinx.io.readUByte","location":"kotlinx-io-core/kotlinx.io/read-u-byte.html","searchKeys":["readUByte","fun Source.readUByte(): UByte","kotlinx.io.readUByte"]},{"name":"fun Source.readUInt(): UInt","description":"kotlinx.io.readUInt","location":"kotlinx-io-core/kotlinx.io/read-u-int.html","searchKeys":["readUInt","fun Source.readUInt(): UInt","kotlinx.io.readUInt"]},{"name":"fun Source.readUIntLe(): UInt","description":"kotlinx.io.readUIntLe","location":"kotlinx-io-core/kotlinx.io/read-u-int-le.html","searchKeys":["readUIntLe","fun Source.readUIntLe(): UInt","kotlinx.io.readUIntLe"]},{"name":"fun Source.readULong(): ULong","description":"kotlinx.io.readULong","location":"kotlinx-io-core/kotlinx.io/read-u-long.html","searchKeys":["readULong","fun Source.readULong(): ULong","kotlinx.io.readULong"]},{"name":"fun Source.readULongLe(): ULong","description":"kotlinx.io.readULongLe","location":"kotlinx-io-core/kotlinx.io/read-u-long-le.html","searchKeys":["readULongLe","fun Source.readULongLe(): ULong","kotlinx.io.readULongLe"]},{"name":"fun Source.readUShort(): UShort","description":"kotlinx.io.readUShort","location":"kotlinx-io-core/kotlinx.io/read-u-short.html","searchKeys":["readUShort","fun Source.readUShort(): UShort","kotlinx.io.readUShort"]},{"name":"fun Source.readUShortLe(): UShort","description":"kotlinx.io.readUShortLe","location":"kotlinx-io-core/kotlinx.io/read-u-short-le.html","searchKeys":["readUShortLe","fun Source.readUShortLe(): UShort","kotlinx.io.readUShortLe"]},{"name":"fun Source.startsWith(byte: Byte): Boolean","description":"kotlinx.io.startsWith","location":"kotlinx-io-core/kotlinx.io/starts-with.html","searchKeys":["startsWith","fun Source.startsWith(byte: Byte): Boolean","kotlinx.io.startsWith"]},{"name":"fun clear()","description":"kotlinx.io.Buffer.clear","location":"kotlinx-io-core/kotlinx.io/-buffer/clear.html","searchKeys":["clear","fun clear()","kotlinx.io.Buffer.clear"]},{"name":"fun copy(): Buffer","description":"kotlinx.io.Buffer.copy","location":"kotlinx-io-core/kotlinx.io/-buffer/copy.html","searchKeys":["copy","fun copy(): Buffer","kotlinx.io.Buffer.copy"]},{"name":"fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)","description":"kotlinx.io.Buffer.copyTo","location":"kotlinx-io-core/kotlinx.io/-buffer/copy-to.html","searchKeys":["copyTo","fun copyTo(out: Buffer, startIndex: Long = 0, endIndex: Long = size)","kotlinx.io.Buffer.copyTo"]},{"name":"fun discardingSink(): RawSink","description":"kotlinx.io.discardingSink","location":"kotlinx-io-core/kotlinx.io/discarding-sink.html","searchKeys":["discardingSink","fun discardingSink(): RawSink","kotlinx.io.discardingSink"]},{"name":"inline fun Sink.writeToInternalBuffer(lambda: (Buffer) -> Unit)","description":"kotlinx.io.writeToInternalBuffer","location":"kotlinx-io-core/kotlinx.io/write-to-internal-buffer.html","searchKeys":["writeToInternalBuffer","inline fun Sink.writeToInternalBuffer(lambda: (Buffer) -> Unit)","kotlinx.io.writeToInternalBuffer"]},{"name":"interface RawSource : AutoCloseable","description":"kotlinx.io.RawSource","location":"kotlinx-io-core/kotlinx.io/-raw-source/index.html","searchKeys":["RawSource","interface RawSource : AutoCloseable","kotlinx.io.RawSource"]},{"name":"open override fun close()","description":"kotlinx.io.Buffer.close","location":"kotlinx-io-core/kotlinx.io/-buffer/close.html","searchKeys":["close","open override fun close()","kotlinx.io.Buffer.close"]},{"name":"open override fun emit()","description":"kotlinx.io.Buffer.emit","location":"kotlinx-io-core/kotlinx.io/-buffer/emit.html","searchKeys":["emit","open override fun emit()","kotlinx.io.Buffer.emit"]},{"name":"open override fun exhausted(): Boolean","description":"kotlinx.io.Buffer.exhausted","location":"kotlinx-io-core/kotlinx.io/-buffer/exhausted.html","searchKeys":["exhausted","open override fun exhausted(): Boolean","kotlinx.io.Buffer.exhausted"]},{"name":"open override fun flush()","description":"kotlinx.io.Buffer.flush","location":"kotlinx-io-core/kotlinx.io/-buffer/flush.html","searchKeys":["flush","open override fun flush()","kotlinx.io.Buffer.flush"]},{"name":"open override fun hintEmit()","description":"kotlinx.io.Buffer.hintEmit","location":"kotlinx-io-core/kotlinx.io/-buffer/hint-emit.html","searchKeys":["hintEmit","open override fun hintEmit()","kotlinx.io.Buffer.hintEmit"]},{"name":"open override fun peek(): Source","description":"kotlinx.io.Buffer.peek","location":"kotlinx-io-core/kotlinx.io/-buffer/peek.html","searchKeys":["peek","open override fun peek(): Source","kotlinx.io.Buffer.peek"]},{"name":"open override fun readAtMostTo(sink: Buffer, byteCount: Long): Long","description":"kotlinx.io.Buffer.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html","searchKeys":["readAtMostTo","open override fun readAtMostTo(sink: Buffer, byteCount: Long): Long","kotlinx.io.Buffer.readAtMostTo"]},{"name":"open override fun readAtMostTo(sink: ByteArray, startIndex: Int, endIndex: Int): Int","description":"kotlinx.io.Buffer.readAtMostTo","location":"kotlinx-io-core/kotlinx.io/-buffer/read-at-most-to.html","searchKeys":["readAtMostTo","open override fun readAtMostTo(sink: ByteArray, startIndex: Int, endIndex: Int): Int","kotlinx.io.Buffer.readAtMostTo"]},{"name":"open override fun readByte(): Byte","description":"kotlinx.io.Buffer.readByte","location":"kotlinx-io-core/kotlinx.io/-buffer/read-byte.html","searchKeys":["readByte","open override fun readByte(): Byte","kotlinx.io.Buffer.readByte"]},{"name":"open override fun readInt(): Int","description":"kotlinx.io.Buffer.readInt","location":"kotlinx-io-core/kotlinx.io/-buffer/read-int.html","searchKeys":["readInt","open override fun readInt(): Int","kotlinx.io.Buffer.readInt"]},{"name":"open override fun readLong(): Long","description":"kotlinx.io.Buffer.readLong","location":"kotlinx-io-core/kotlinx.io/-buffer/read-long.html","searchKeys":["readLong","open override fun readLong(): Long","kotlinx.io.Buffer.readLong"]},{"name":"open override fun readShort(): Short","description":"kotlinx.io.Buffer.readShort","location":"kotlinx-io-core/kotlinx.io/-buffer/read-short.html","searchKeys":["readShort","open override fun readShort(): Short","kotlinx.io.Buffer.readShort"]},{"name":"open override fun readTo(sink: RawSink, byteCount: Long)","description":"kotlinx.io.Buffer.readTo","location":"kotlinx-io-core/kotlinx.io/-buffer/read-to.html","searchKeys":["readTo","open override fun readTo(sink: RawSink, byteCount: Long)","kotlinx.io.Buffer.readTo"]},{"name":"open override fun request(byteCount: Long): Boolean","description":"kotlinx.io.Buffer.request","location":"kotlinx-io-core/kotlinx.io/-buffer/request.html","searchKeys":["request","open override fun request(byteCount: Long): Boolean","kotlinx.io.Buffer.request"]},{"name":"open override fun require(byteCount: Long)","description":"kotlinx.io.Buffer.require","location":"kotlinx-io-core/kotlinx.io/-buffer/require.html","searchKeys":["require","open override fun require(byteCount: Long)","kotlinx.io.Buffer.require"]},{"name":"open override fun skip(byteCount: Long)","description":"kotlinx.io.Buffer.skip","location":"kotlinx-io-core/kotlinx.io/-buffer/skip.html","searchKeys":["skip","open override fun skip(byteCount: Long)","kotlinx.io.Buffer.skip"]},{"name":"open override fun toString(): String","description":"kotlinx.io.Buffer.toString","location":"kotlinx-io-core/kotlinx.io/-buffer/to-string.html","searchKeys":["toString","open override fun toString(): String","kotlinx.io.Buffer.toString"]},{"name":"open override fun transferFrom(source: RawSource): Long","description":"kotlinx.io.Buffer.transferFrom","location":"kotlinx-io-core/kotlinx.io/-buffer/transfer-from.html","searchKeys":["transferFrom","open override fun transferFrom(source: RawSource): Long","kotlinx.io.Buffer.transferFrom"]},{"name":"open override fun transferTo(sink: RawSink): Long","description":"kotlinx.io.Buffer.transferTo","location":"kotlinx-io-core/kotlinx.io/-buffer/transfer-to.html","searchKeys":["transferTo","open override fun transferTo(sink: RawSink): Long","kotlinx.io.Buffer.transferTo"]},{"name":"open override fun write(source: Buffer, byteCount: Long)","description":"kotlinx.io.Buffer.write","location":"kotlinx-io-core/kotlinx.io/-buffer/write.html","searchKeys":["write","open override fun write(source: Buffer, byteCount: Long)","kotlinx.io.Buffer.write"]},{"name":"open override fun write(source: ByteArray, startIndex: Int, endIndex: Int)","description":"kotlinx.io.Buffer.write","location":"kotlinx-io-core/kotlinx.io/-buffer/write.html","searchKeys":["write","open override fun write(source: ByteArray, startIndex: Int, endIndex: Int)","kotlinx.io.Buffer.write"]},{"name":"open override fun write(source: RawSource, byteCount: Long)","description":"kotlinx.io.Buffer.write","location":"kotlinx-io-core/kotlinx.io/-buffer/write.html","searchKeys":["write","open override fun write(source: RawSource, byteCount: Long)","kotlinx.io.Buffer.write"]},{"name":"open override fun writeByte(byte: Byte)","description":"kotlinx.io.Buffer.writeByte","location":"kotlinx-io-core/kotlinx.io/-buffer/write-byte.html","searchKeys":["writeByte","open override fun writeByte(byte: Byte)","kotlinx.io.Buffer.writeByte"]},{"name":"open override fun writeInt(int: Int)","description":"kotlinx.io.Buffer.writeInt","location":"kotlinx-io-core/kotlinx.io/-buffer/write-int.html","searchKeys":["writeInt","open override fun writeInt(int: Int)","kotlinx.io.Buffer.writeInt"]},{"name":"open override fun writeLong(long: Long)","description":"kotlinx.io.Buffer.writeLong","location":"kotlinx-io-core/kotlinx.io/-buffer/write-long.html","searchKeys":["writeLong","open override fun writeLong(long: Long)","kotlinx.io.Buffer.writeLong"]},{"name":"open override fun writeShort(short: Short)","description":"kotlinx.io.Buffer.writeShort","location":"kotlinx-io-core/kotlinx.io/-buffer/write-short.html","searchKeys":["writeShort","open override fun writeShort(short: Short)","kotlinx.io.Buffer.writeShort"]},{"name":"open override val buffer: Buffer","description":"kotlinx.io.Buffer.buffer","location":"kotlinx-io-core/kotlinx.io/-buffer/buffer.html","searchKeys":["buffer","open override val buffer: Buffer","kotlinx.io.Buffer.buffer"]},{"name":"operator fun get(position: Long): Byte","description":"kotlinx.io.Buffer.get","location":"kotlinx-io-core/kotlinx.io/-buffer/get.html","searchKeys":["get","operator fun get(position: Long): Byte","kotlinx.io.Buffer.get"]},{"name":"sealed interface FileSystem","description":"kotlinx.io.files.FileSystem","location":"kotlinx-io-core/kotlinx.io.files/-file-system/index.html","searchKeys":["FileSystem","sealed interface FileSystem","kotlinx.io.files.FileSystem"]},{"name":"sealed interface Sink : RawSink","description":"kotlinx.io.Sink","location":"kotlinx-io-core/kotlinx.io/-sink/index.html","searchKeys":["Sink","sealed interface Sink : RawSink","kotlinx.io.Sink"]},{"name":"sealed interface Source : RawSource","description":"kotlinx.io.Source","location":"kotlinx-io-core/kotlinx.io/-source/index.html","searchKeys":["Source","sealed interface Source : RawSource","kotlinx.io.Source"]},{"name":"val isDirectory: Boolean = false","description":"kotlinx.io.files.FileMetadata.isDirectory","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/is-directory.html","searchKeys":["isDirectory","val isDirectory: Boolean = false","kotlinx.io.files.FileMetadata.isDirectory"]},{"name":"val isRegularFile: Boolean = false","description":"kotlinx.io.files.FileMetadata.isRegularFile","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/is-regular-file.html","searchKeys":["isRegularFile","val isRegularFile: Boolean = false","kotlinx.io.files.FileMetadata.isRegularFile"]},{"name":"val size: Long","description":"kotlinx.io.Buffer.size","location":"kotlinx-io-core/kotlinx.io/-buffer/size.html","searchKeys":["size","val size: Long","kotlinx.io.Buffer.size"]},{"name":"val size: Long = 0","description":"kotlinx.io.files.FileMetadata.size","location":"kotlinx-io-core/kotlinx.io.files/-file-metadata/size.html","searchKeys":["size","val size: Long = 0","kotlinx.io.files.FileMetadata.size"]}] \ No newline at end of file diff --git a/gradle.properties b/gradle.properties index e241fe07..3ea8fdde 100644 --- a/gradle.properties +++ b/gradle.properties @@ -4,7 +4,7 @@ # group=org.jetbrains.kotlinx -version=0.5.3 +version=0.5.4 kotlin.code.style=official org.gradle.jvmargs=-Xmx4G nativeBenchmarksEnabled=true