SlotReader

Kotlin |Java

class SlotReader : SlotEditor

kotlin.Any
↳	androidx.compose.SlotEditor
	↳	androidx.compose.SlotReader

Summary

Public methods
Unit	`beginEmpty()` Begin reporting empty for all calls to next() or get().
Unit	`close()`
Unit	`endEmpty()` End reporting empty for calls to net() and get().
Int	`endGroup()` End the current group.
Int	`endNode()` End a node
MutableList<KeyInfo>	`extractKeys()` Extract the keys from this point to the end of the group.
Any?	`get()` Get the value at the current slot
Any	`groupKey(index: Int)` Return the group key at index.
Any?	`next()` Get the value of the next slot.
Unit	`previous()` Backup one slot.
Unit	`reportUncertainNodeCount()`
Int	`skipEnclosingGroup()` Skip the to the end of the group.
Int	`skipGroup()` Skip a group.
Int	`skipNode()` Skip a node
Unit	`startGroup(key: Any)` Start a group.
Unit	`startNode(key: Any)` Start a node.
String	`toString()`

From class SlotEditor

`Any?`	`get(anchor: Anchor)` Get the value at an Anchor
`Any?`	`get(index: Int)` Get the value at the index'th slot.
`Int`	`groupSize(index: Int)` Return the size of the group at index. isGroup(index) must be true of this will throw.
`Boolean`	`isGroup(index: Int)` Return true if the slot at index starts a gorup

Properties
Any	`groupKey` Return the key for the current group or EMPTY
Boolean	`inEmpty`
Boolean	`isGroupEnd` Return true if the current location is at the end of a group

From class SlotEditor

`Int`	`current`
`Int`	`groupSize` Return the number of nodes in the group. isGroup must be true or this will throw.
`Boolean`	`isGroup` Return true if the current slot starts a group
`Boolean`	`isNode` Return true if the current slot starts a node. A node is a kind of group so this will return true for isGroup as well.
`Int`	`nodeIndex` Get the number of nodes emitted to the group prior to the current slot.
`Int`	`parentIndex`
`Int`	`parentNodes` Get the total number of nodes emitted in the group containing the current.
`SlotTable`	`table`

fun beginEmpty(): Unit

Begin reporting empty for all calls to next() or get(). beginEmpty() can be nested and must be called with a balanced number of endEmpty()

fun close(): Unit

fun endEmpty(): Unit

End reporting empty for calls to net() and get().

fun endGroup(): Int

End the current group. Must be called after the corresponding startGroup().

fun endNode(): Int

End a node

fun extractKeys(): MutableList<KeyInfo>

Extract the keys from this point to the end of the group. The current is left unaffected. Must be called inside a group.

fun get(): Any?

Get the value at the current slot

fun groupKey(index: Int): Any

Return the group key at index. isGroup(index) must be true or this will throw.

fun next(): Any?

Get the value of the next slot. During empty mode this value is always EMPTY which is the value a newly inserted slot.

fun previous(): Unit

Backup one slot. For example, we ran into a key of a keyed group we don't want, this backs up current to be before the key.

fun reportUncertainNodeCount(): Unit

fun skipEnclosingGroup(): Int

Skip the to the end of the group.

fun skipGroup(): Int

Skip a group. Must be called at the start of a group.

fun skipNode(): Int

Skip a node

fun startGroup(key: Any): Unit

Start a group. Passing an EMPTY as the key will enter the group without validating the key.

fun startNode(key: Any): Unit

Start a node.

fun toString(): String

val groupKey: Any

Return the key for the current group or EMPTY

val inEmpty: Boolean

val isGroupEnd: Boolean

Return true if the current location is at the end of a group