kotter/com.varabyte.kotter.runtime/RunScope

RunScope

class RunScope(val section: Section, scope: CoroutineScope) : SectionScope(source)

A scope associated with the run function.

While its Lifecycle is probably almost the same as its section's lifecycle, it is a little shorter, and this matters because some data may need to be cleaned up after running but before the block is actually finished.

Constructors

RunScope

constructor(section: Section, scope: CoroutineScope)

Types

Lifecycle

object Lifecycle : ConcurrentScopedData.Lifecycle

Properties

data

open override val data: ConcurrentScopedData

Data store for this session.

section

val section: Section

The Section this run block is attached to.

Functions

addShutdownHook

fun RunScope.addShutdownHook(dispose: () -> Unit)

Add some dispose logic, tied to the current section, which should run if the user tries to exit the application via Ctrl-C.

addTimer

fun RunScope.addTimer(duration: Duration, repeat: Boolean = false, key: Any? = null, callback: TimerScope.() -> Unit)

Add a timer that will be fired as long as the current section is still running.

aside

fun RunScope.aside(render: AsideRenderScope.() -> Unit)

A one-off render block that can be triggered within a RenderScope.run block.

awaitActiveRender

suspend fun awaitActiveRender()

Waits for the currently requested or active render pass to finish executing if one is in progress.

enterInput

fun RunScope.enterInput()

Programmatically trigger an "input entered" event.

getInput

fun SectionScope.getInput(id: Any = Unit): String?

Fetch the current value of some input call from anywhere within a RunScope.run block, if one is set.

onInputActivated

fun RunScope.onInputActivated(listener: OnInputActivatedScope.() -> Unit)

A callback you can register in a RunScope.run block that will get triggered any time an input gains focus.

onInputChanged

fun RunScope.onInputChanged(listener: OnInputChangedScope.() -> Unit)

A callback you can register in a RunScope.run block that will get triggered any time the changes their input.

onInputCursorChanged

fun RunScope.onInputCursorChanged(listener: OnInputCursorChangedScope.() -> Unit)

A callback you can register in a RunScope.run block that will get triggered any time the user moves their cursor around the input value.

onInputDeactivated

fun RunScope.onInputDeactivated(listener: OnInputDeactivatedScope.() -> Unit)

A callback you can register in a RunScope.run block that will get triggered any time an input loses focus.

onInputEntered

fun RunScope.onInputEntered(listener: OnInputEnteredScope.() -> Unit)

A callback you can register in a RunScope.run block which will get triggered any time the user presses the ENTER key an input area that has focus.

onKeyPressed

fun RunScope.onKeyPressed(listener: OnKeyPressedScope.() -> Unit)

A handler you can register in a RunScope.run block to intercept keypresses.

onTerminalSizeChanged

fun RunScope.onTerminalSizeChanged(callback: OnTerminalSizeChangedScope.() -> Unit)

Add a listener that gets triggered every time the terminal is resized.

rerender

fun rerender()

Request an additional rerender pass against the underlying section.

sendKeys

fun RunScope.sendKeys(vararg keys: Key)

Send one or more Key presses programmatically.

setInput

fun RunScope.setInput(text: String, cursorIndex: Int = text.length, id: Any = Unit)

Set the value for some input call directly from anywhere in a RunScope.run block.

signal

fun signal(): Boolean

Fire a signal so that waitForSignal is allowed to continue.

waitForSignal

suspend fun waitForSignal()

Block this method from continuing until signal is called.