osteak - GitLite

KO | EN

gitlite — search

#anthropic #linux #openai #c #awesome-list #security #nextjs #swift #markdown #privacy

osteak

(★ 17)

Elm for ratatui — you bring the loop

파일 탐색기

ZIP 다운로드

- - ci.yml
  - release.yml
- - issues.jsonl
- boot.md
- EVALUATION.md
- REQUIREMENTS.md
- async_tasks.rs
- counter.rs
- counter_manual.rs
- multi_pane.rs
- action.rs
- cmd.rs
- lib.rs
- runner.rs
- sub.rs
- composition.rs
- sub_lazy.rs
- tea_cycle.rs
.gitignore
Cargo.toml
CHANGELOG.md
CONTRIBUTING.md
LICENSE-MIT
osteak.bail
README.md
rustfmt.toml

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

명령어 용어집

이 문서에서 사용된 명령어를 모아봤습니다. 낯선 명령어가 있다면 펼쳐서 확인해보세요.

🔍

`cargo add`

설명 보기 ▼

Add dependencies to a Rust project's `Cargo.toml` manifest.

cargo add {{dependency}}

Add the latest version of a dependency to the current project:

cargo add {{dependency}}@{{version}}

Add a specific version of a dependency:

cargo add {{dependency}} {{[-F|--features]}} {{feature_1,feature_2,...}}

Add a dependency and enable one or more specific features:

# 프로젝트 배지

Crates.io 바로가기
docs.rs 바로가기
CI 바로가기
License 바로가기

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Elm Architecture for ratatui. We built this because our TUI kept
accumulating state bugs as it grew — booleans disagreeing, async
tasks outliving the UI state that spawned them, the usual. TEA
fixed it for us. Maybe it helps you too.

You bring the event loop. osteak gives you `update`, `view`, and
a `Cmd` type to describe side effects. There's an optional runner
if you don't have a loop yet.

## Quick Start

```sh
cargo add osteak
```

```rust
use osteak::{Tea, Cmd};
use ratatui::Frame;
use ratatui::widgets::Paragraph;

struct Counter { count: i32 }

enum Msg { Increment, Decrement, Quit }

impl Tea for Counter {
    type Msg = Msg;

fn update(&mut self, msg: Msg) -> Cmd<Msg> {
        match msg {
            Msg::Increment => { self.count += 1; Cmd::dirty() }
            Msg::Decrement => { self.count -= 1; Cmd::dirty() }
            Msg::Quit => Cmd::quit(),
        }
    }

fn view(&mut self, frame: &mut Frame) {
        let text = format!("Count: {}", self.count);
        frame.render_widget(Paragraph::new(text), frame.area());
    }
}
```

### With the built-in runner

```rust,no_run
# use osteak::{Tea, Cmd};
# use ratatui::Frame;
# use ratatui::widgets::Paragraph;
# struct Counter { count: i32 }
# enum Msg { Increment, Decrement, Quit }
# impl Tea for Counter {
#     type Msg = Msg;
#     fn update(&mut self, msg: Msg) -> Cmd<Msg> { Cmd::none() }
#     fn view(&mut self, frame: &mut Frame) {}
# }
use crossterm::event::{Event, KeyCode, KeyEventKind};

#[tokio::main]
async fn main() -> std::io::Result<()> {
    osteak::runner::run(Counter { count: 0 }, |ev| {
        let Event::Key(k) = ev else { return None };
        if k.kind != KeyEventKind::Press { return None; }
        match k.code {
            KeyCode::Up => Some(Msg::Increment),
            KeyCode::Down => Some(Msg::Decrement),
            KeyCode::Char('q') => Some(Msg::Quit),
            _ => None,
        }
    }).await
}
```

### Without the runner

Write your own loop — osteak doesn't take control.
See [`examples/counter_manual.rs`](examples/counter_manual.rs).

## Architecture

```text
    ┌──────────────────────┐
    │    Your Event Loop    │
    │  (or osteak::runner)  │
    └──────┬───────────────┘
           │ Msg
    ┌──────▼───────────────┐
    │   Tea::update(&mut)   │
    │   → Cmd { action,     │
    │         dirty }       │
    └──────┬───────────────┘
           │
  ┌────────┼────────┐
  │        │        │
Task     None     Quit
(you spawn)
  │
  │ Msg (on completion)
  └──────► back to update
```

## Features

| Feature | Default | Description |
|---------|---------|-------------|
| `crossterm-backend` | yes | Crossterm backend + `EventStream` |
| `tokio-runtime` | yes | Tokio integration for the runner |

Just the traits, no runtime:

```sh
cargo add osteak --no-default-features
```

## Examples

- [`counter`](examples/counter.rs) — with the runner
- [`counter_manual`](examples/counter_manual.rs) — hand-written event loop
- [`async_tasks`](examples/async_tasks.rs) — `Cmd::task` + `tokio::spawn`
- [`multi_pane`](examples/multi_pane.rs) — composition with `Cmd::map`

```sh
cargo run --example counter
```

## MSRV

1.86.0 (same as ratatui 0.30).

## License

[MIT](LICENSE-MIT)