File: linenoise.md

package info (click to toggle)
rust-rustyline 14.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 820 kB
  • sloc: makefile: 2
file content (34 lines) | stat: -rw-r--r-- 2,317 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Mapping between linenoise API and rustyline API

| linenoise                      | rustyline                    | Remarks                   |
|--------------------------------|------------------------------|---------------------------|
| linenoiseState                 | State                        |                           |
| *Blocking API*                 |
| linenoise                      | Editor::readline             |
| linenoiseFree                  | _                            | RAII                      |
| *Non blocking API*             |                              |
| linenoiseEditStart             | _                            |
| linenoiseEditFeed              | _                            |
| linenoiseEditStop              | _                            |
| linenoiseHide                  | Renderer::clear_rows         |
| linenoiseShow                  | State::refresh_line          |
| *Completion API*               |
| linenoiseCompletions           | Vec<Candidate>               |
| linenoiseCompletionCallback    | Completer                    |
| linenoiseAddCompletion         | _                            | std Vec::add              |
| linenoiseSetCompletionCallback | Editor::set_helper           |
| linenoiseHintsCallback         | Hinter                       |
| linenoiseSetHintsCallback      | Editor::set_helper           |
| linenoiseFreeHintsCallback     | _                            | RAII                      |
| linenoiseSetFreeHintsCallback  | _                            | RAII                      |
| *History API*                  |
| linenoiseHistoryAdd            | Editor::add_history_entry    |
| linenoiseHistorySetMaxLen      | Editor::set_max_history_size |
| linenoiseHistorySave           | Editor::save_history         |
| linenoiseHistoryLoad           | Editor::load_history         |
| *Other utilities*              |
| linenoiseClearScreen           | Editor::clear_screen         |
| linenoiseSetMultiLine          | _                            | Always activated          |
| linenoisePrintKeyCodes         | _                            | debug logs                |
| linenoiseMaskModeEnable        | _                            | see read_password example |
| linenoiseMaskModeDisable       | _                            |