utils/dev.kindling.utils.state/KQueue

KQueue

class KQueue<T>(initialItems: List<T> = emptyList())(source)

A reactive FIFO queue.

Port of the useQueue React hook (which itself built on useArray).

val queue = KQueue<String>()
queue.enqueue("first")
queue.enqueue("second")

println(queue.peek())    // "first"
println(queue.dequeue()) // "first"
println(queue.size)      // 1

// Observe reactively:
queue.state.collect { items -> render(items) }

Parameters

initialItems

Items to pre-populate the queue with (front → back order).

Constructors

KQueue

constructor(initialItems: List<T> = emptyList())

Properties

isEmpty

val isEmpty: Boolean

true when the queue contains no items.

size

val size: Int

Number of items currently in the queue.

state

val state: StateFlow<List<T>>

The underlying queue contents as a StateFlow (front → back).

Functions

clear

fun clear()

Removes all items from the queue.

dequeue

fun dequeue(): T?

Removes and returns the front item, or null if the queue is empty.

enqueue

fun enqueue(item: T)

Adds item to the back of the queue.

peek

fun peek(): T?

Returns the front item without removing it, or null if empty.

toString

open override fun toString(): String