kitetorrent/io.github.yuroyami.kitetorrent/Bitfield

Bitfield

A bitfield of arbitrary length. This is a pure-Kotlin port of libtorrent's bitfield (bitfield.hpp). It tracks which pieces a peer has, and which we have.

Stored MSB-first within each byte (bit 0 is 0x80 of byte 0), which is exactly the on-the-wire layout of the BitTorrent bitfield message. data can therefore be sent, and assign can read a received bitfield, with no reordering. libtorrent reaches the same layout via network-byte-order 32-bit words; a byte array is the simpler equivalent on the JVM/Native/JS, where we have no raw-pointer aliasing.

Constructors

constructor()

constructor(bits: Int, value: Boolean = false)

A bitfield of bits length, all zero (or all value if given).

Types

object Companion

Functions

fun allSet(): Boolean

True if every bit is 1.

fun assign(bytes: ByteArray, bitCount: Int)

Copy bitCount bits from bytes (rounded up to whole bytes).

fun clear()

Drop all bits, making the bitfield empty.

Set every bit to 0.

fun clearBit(index: Int)

fun count(): Int

Number of bits set to 1.

fun data(): ByteArray

The backing bytes, ready to drop into a wire bitfield message.

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

fun findFirstSet(): Int

Index of the first set (1) bit, or -1 if none.

fun findLastClear(): Int

Index of the last cleared (0) bit, or -1 if every bit is set.

operator fun get(index: Int): Boolean

fun getBit(index: Int): Boolean

open override fun hashCode(): Int

fun isEmpty(): Boolean

True if the bitfield has zero length.

fun noneSet(): Boolean

True if no bit is 1.

fun numBytes(): Int

Number of bytes backing the bits.

fun resize(newBits: Int, value: Boolean = false)

Resize to newBits length; bits added on growth take value.

fun setAll()

Set every bit to 1 (trailing bits in the final byte are left clear).

fun setBit(index: Int)

fun setBit(index: Int, value: Boolean)

fun size(): Int

Number of bits in the bitfield.

open override fun toString(): String