Kapacity IO/io.github.developrofthings.kapacity.io

Package-level declarations

Properties

Returns an estimate of the number of bytes that can be read (or skipped over) from this InputStream without blocking, safely wrapped as a Kapacity instance.

kapacity

val File.kapacity: Kapacity

Returns the Kapacity of this File, calculated directly from its length on the disk.

val ByteBuffer.kapacity: Kapacity

Returns the Kapacity of this ByteBuffer, calculated directly from its length on the disk.

val Path.kapacity: Kapacity

Returns the Kapacity of this Path, calculated directly from its length on the disk.

val Buffer.kapacity: Kapacity

Returns the Kapacity of this Buffer, calculated directly from its size.

val ByteString.kapacity: Kapacity

Returns the Kapacity of this immutable ByteString, calculated directly from its size.

val ByteStringBuilder.kapacity: Kapacity

Returns the Kapacity of the data currently written to this ByteStringBuilder, calculated directly from its current size.

val NSData.kapacity: Kapacity

Returns the Kapacity of this NSData buffer, calculated directly from its length in memory.

val NSURL.kapacity: Kapacity

Returns the Kapacity of this NSURL, calculated directly from its file size on the disk.

Functions

allocateByteBuffer

fun Kapacity.allocateByteBuffer(): ByteBuffer

Allocates a new standard (heap-backed) ByteBuffer with a capacity equal to this Kapacity.

directAllocateByteBuffer

fun Kapacity.directAllocateByteBuffer(): ByteBuffer

Allocates a new direct (off-heap) ByteBuffer with a capacity equal to this Kapacity.

get

fun ByteBuffer.get(destination: ByteArray, destinationOffset: Int = 0, kapacity: Kapacity): ByteBuffer

Reads up to the specified kapacity of bytes from this buffer into the destination array.

put

fun ByteBuffer.put(source: ByteArray, sourceOffset: Int = 0, kapacity: Kapacity): ByteBuffer

Writes up to the specified kapacity of bytes from the source array into this buffer.

read

fun InputStream.read(destination: ByteArray, destinationOffset: Int = 0, kapacity: Kapacity): Int

Reads up to the specified kapacity of bytes from this input stream into the given destination array.

readAtMostTo

fun Buffer.readAtMostTo(sink: Buffer, kapacity: Kapacity): Kapacity

Removes up to the specified kapacity of bytes from this buffer and appends them to the sink.

fun Buffer.readAtMostTo(sink: ByteArray, startIndex: Int = 0, kapacity: Kapacity): Kapacity

Removes up to the specified kapacity of bytes from this buffer and writes them into the provided sink array.

readKapacity

fun InputStream.readKapacity(destination: ByteArray, destinationOffset: Int = 0, kapacity: Kapacity): Kapacity

Reads up to the specified kapacity of bytes from this input stream into the given destination array, returning the result as a Kapacity instance.

readTo

fun Buffer.readTo(sink: RawSink, kapacity: Kapacity)

Removes exactly the specified kapacity of bytes from this buffer and appends them to the sink.

skip

fun Buffer.skip(kapacity: Kapacity)

Removes and discards the exact number of bytes represented by the given kapacity from this buffer.

substring

fun ByteString.substring(startIndex: Int = 0, kapacity: Kapacity): ByteString

Returns a new ByteString containing a subset of bytes from this instance, starting at the startIndex and capturing up to the specified kapacity.

toNSData

fun Kapacity.toNSData(): NSData

Allocates a new native Apple NSData buffer initialized with zeros, sized exactly to this Kapacity.

toNSMutableData

fun Kapacity.toNSMutableData(): NSMutableData

Allocates a new native Apple NSMutableData buffer initialized with zeros, sized exactly to this Kapacity.

write

fun OutputStream.write(source: ByteArray, sourceOffset: Int = 0, kapacity: Kapacity)

Writes up to the specified kapacity of bytes from the source array to this output stream.

fun Buffer.write(source: RawSource, kapacity: Kapacity)

Appends exactly the specified kapacity of bytes from the source into this buffer.

fun Buffer.write(source: ByteArray, startIndex: Int = 0, kapacity: Kapacity)

Appends the specified kapacity of bytes from the source array into this buffer.