#read-line #command-line #history #word #completion #search #unicode

已删除 rustyline-with-hint-fix

Rustyline,基于Antirez的Linenoise的readline实现

25个稳定版本 (6个主要版本)

12.0.1 2023年9月6日
12.0.0 2023年7月21日
11.0.0 2023年5月29日
10.1.0 2023年2月5日
6.3.0 2020年10月26日

#57 in #read-line

每月下载量 32次

MIT 许可证

485KB
12K SLoC

RustyLine

Build Status dependency status Docs

Rust中的Readline实现,基于Antirez的Linenoise

支持的平台

  • Unix(在FreeBSD、Linux和macOS上进行了测试)
  • Windows
    • cmd.exe
    • Powershell

注意:

  • Powershell ISE不受支持,请参阅问题#56
  • Mintty(Cygwin/MinGW)不受支持
  • Windows < Windows 10上不支持高亮/颜色,除非使用ConEmu和ColorMode::Forced

示例

use rustyline::error::ReadlineError;
use rustyline::{DefaultEditor, Result};

fn main() -> Result<()> {
    // `()` can be used when no completer is required
    let mut rl = DefaultEditor::new()?;
    #[cfg(feature = "with-file-history")]
    if rl.load_history("history.txt").is_err() {
        println!("No previous history.");
    }
    loop {
        let readline = rl.readline(">> ");
        match readline {
            Ok(line) => {
                rl.add_history_entry(line.as_str());
                println!("Line: {}", line);
            },
            Err(ReadlineError::Interrupted) => {
                println!("CTRL-C");
                break
            },
            Err(ReadlineError::Eof) => {
                println!("CTRL-D");
                break
            },
            Err(err) => {
                println!("Error: {:?}", err);
                break
            }
        }
    }
    #[cfg(feature = "with-file-history")]
    rl.save_history("history.txt");
    Ok(())
}

crates.io

您可以通过在您的Cargo.toml中添加以下内容来在项目中使用此包

[dependencies]
rustyline = "12.0.0"

功能

  • Unicode (UTF-8)(linenoise仅支持ASCII)
  • 单词完成(linenoise仅支持行完成)
  • 文件名完成
  • 历史搜索(在历史中搜索命令
  • 杀环(删除命令
  • 多行支持(换行)
  • 单词命令
  • 提示

动作

所有模式

按键 动作
Home 将光标移到行的开头
End 将光标移到行的末尾
Left 将光标向左移动一个字符
Right 将光标向右移动一个字符
Ctrl-C 中断/取消编辑
Ctrl-D, Del (如果行不为空) 删除光标下的字符
Ctrl-D (如果行不为空) 文件结束
Ctrl-J, Ctrl-M, Enter 完成行输入
Ctrl-R 反向搜索历史记录(Ctrl-S 向前,Ctrl-G 取消)
Ctrl-T 交换前一个字符与当前字符
Ctrl-U 从行的开头删除到光标处
Ctrl-V 插入任何特殊字符而不执行其相关操作 (#65)
Ctrl-W 删除光标前的单词(使用空白作为单词边界)
Ctrl-Y 从剪切板粘贴
Ctrl-Z 挂起(仅限Unix)
Ctrl-_ 撤销

Emacs模式(默认模式)

按键 动作
Ctrl-A, Home 将光标移到行的开头
Ctrl-B, 左 将光标向左移动一个字符
Ctrl-E, End 将光标移到行的末尾
Ctrl-F, 右 将光标向右移动一个字符
Ctrl-H, Backspace 删除光标前的字符
Ctrl-I, Tab 下一个完成项
Ctrl-K 从光标处删除到行尾
Ctrl-L 清除屏幕
Ctrl-N, 向下 从历史记录中下一个匹配项
Ctrl-P, 向上 从历史记录中上一个匹配项
Ctrl-X Ctrl-U 撤销
Ctrl-Y 从剪切板粘贴(使用Meta-Y粘贴下一个剪切项)
Meta-< 移动到历史记录中的第一个条目
Meta-> 移动到历史记录中的最后一个条目
Meta-B, Alt-Left 移动光标到前一个单词
Meta-C 将当前单词大写
Meta-D 删除一个单词向前
Meta-F, Alt-Right 移动光标到下一个单词
Meta-L 将下一个单词小写
Meta-T 交换单词
Meta-U 将下一个单词大写
Meta-Y 参见Ctrl-Y
Meta-Backspace 从当前单词开头删除,或如果在单词之间,则删除到前一个单词的开头
Meta-0, 1, ..., - 指定参数的数字。 开始一个负参数。

Readline Emacs编辑模式速查表

vi命令模式

按键 动作
$, End 将光标移到行的末尾
. 重做最后一个文本修改
; 重做最后一个字符查找命令
, 重做反向的最后一个字符查找命令
0, Home 将光标移到行的开头
^ 移动到行的第一个非空白字符
a 在光标后插入
A 在行尾插入
b 向左移动一个单词或标记
B 向左移动一个非空白单词
c 更改移动命令的文本
C 更改文本到行尾(等同于c$)
d 删除移动命令的文本
D, Ctrl-K 删除到行尾
e 移动到当前单词的末尾
E 移动到当前非空白单词的末尾
f 向右移动到下一个字符的 occurrence
F 向左移动到上一个字符的 occurrence
h, Ctrl-H, Backspace 向左移动一个字符
l, Space 向右移动一个字符
Ctrl-L 清除屏幕
i 在光标前插入
I 在行首插入
+, j, Ctrl-N 向前移动一个历史命令
-, k, Ctrl-P 向后移动一个历史命令
p 在光标处插入剪切文本(粘贴)
P 在光标前插入剪切文本
r 替换光标下的单个字符(不离开命令模式)
s 删除光标下的单个字符并进入输入模式
S 更改当前行(等同于0c$)
t 向右移动到下一个字符的 occurrence,然后向后一个字符
T 向左移动到上一个字符的 occurrence,然后向前一个字符
u 撤销
w 向右移动一个单词或标记
W 向右移动一个非空白单词
x 删除光标下的单个字符
X 删除光标前的字符
y 将移动操作剪切到缓冲区(复制)

vi插入模式

按键 动作
Ctrl-H, Backspace 删除光标前的字符
Ctrl-I, Tab 下一个完成项
Esc 切换到命令模式

Readline vi编辑模式速查表

终端代码(ANSI/VT100)

Wine

$ cargo run --example example --target 'x86_64-pc-windows-gnu'
...
Error: Io(Error { repr: Os { code: 6, message: "Invalid handle." } })
$ wineconsole --backend=curses target/x86_64-pc-windows-gnu/debug/examples/example.exe
...

终端检查

$ # current settings of all terminal attributes:
$ stty -a
$ # key bindings:
$ bind -p
$ # print out a terminfo description:
$ infocmp

类似项目

Lang OS Term Unicode 历史记录 完成项 键映射 剪切环 撤销 颜色 提示/自动建议
go-prompt Go Ux/win ANSI 任何 Emacs/prog
Haskeline Haskell Ux/Win 任何 任何 Emacs/vi/conf ? ?
isocline C Ux/Win ANSI 任何 Emacs
换行符 Rust Ux/Win 任何 任何 Emacs/conf ?
linenoise C Ux ANSI 仅行 Emacs Ux
Liner Rust Ux ANSI 无增量搜索 仅单词 Emacs/vi/prog Ux 基于历史
prompt_toolkit Python Ux/Win ANSI 任何 Emacs/vi/conf Ux/Win
reedline Rust Ux/Win ANSI 任何 Emacs/vi/bind Ux/Win
replxx C/C++ Ux/Win ANSI 仅行 Emacs Ux/Win
Rustyline Rust Ux/Win ANSI 任何 Emacs/vi/bind Ux/Win 10+
termwiz Rust Ux/Win 任何 ? 任何 Emacs Ux/Win

多行支持

这是一个非常简单的功能,它简单地将超过当前终端宽度的行显示在下一视觉行上,而不是在输入更多字符时水平滚动。目前,此功能始终启用,没有配置选项可以禁用它。

此功能不允许最终用户按特殊键序列进入一种模式,在该模式下按回车键将导致在输入缓冲区中添加一个实际的换行符。

实现多行编辑的方法是实现Validator特质。

依赖项

~3–17MB
~220K SLoC