Core LibraryAPI Reference

Choose documentation 1

latest

Current version

latest
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

method libtmux-kotlin latest

Pane.run

Package io.github.libtmux.kotlin.Pane.run io.github.libtmux.kotlin

Runs a shell command in this pane to its end, and answers with its exit status and output.

View as Markdown

Source and package
Module
io.github.libtmux.kotlin
Declared in
Pane
Package
io.github.libtmux:libtmux-kotlin
Source
libtmux-kotlin/src/main/kotlin/io/github/libtmux/kotlin/Pane.kt
public Kotlin suspending functions Allows a function to call suspending operations and pause without blocking a thread. It does not start a coroutine by itself. Language documentation fun run( command: String, timeout: Duration, dispatcher: CoroutineDispatcher = Dispatchers.IO, ): PaneRun
methodasync [source]

Description#

Cancelling the coroutine interrupts the wait. The command keeps running in the pane; only the wait for its end is what cancellation reaches.

Parameters
  • command ( String ) – a line of shell, run as eval would run it

  • timeout ( Duration ) – how long to wait for it to end

  • dispatcher ( CoroutineDispatcher ) – where the blocking wait runs

Returns

the command's exit status and what it printed

Esc

Type to search.