#read-line #rustyline #word #command-line #completion #helper #highlighter

rustyline-derive

Rustyline 宏实现 #[derive(Completer, Helper, Hinter, Highlighter)]

9 个重大版本

0.10.0 2023年12月5日
0.9.0 2023年6月24日
0.8.0 2023年2月19日
0.7.0 2022年7月17日
0.2.0 2019年9月15日

503命令行界面 中排名 #503

Download history 32409/week @ 2024-03-14 32151/week @ 2024-03-21 26220/week @ 2024-03-28 24699/week @ 2024-04-04 25422/week @ 2024-04-11 28734/week @ 2024-04-18 24571/week @ 2024-04-25 26398/week @ 2024-05-02 30489/week @ 2024-05-09 30935/week @ 2024-05-16 24911/week @ 2024-05-23 25733/week @ 2024-05-30 24992/week @ 2024-06-06 26100/week @ 2024-06-13 26864/week @ 2024-06-20 19574/week @ 2024-06-27

102,451 每月下载量
126 crate 中使用(75 直接使用)

MIT 许可证

11KB
184

RustyLine

Build Status dependency status Docs

RustyLine 是基于 Antirez' Linenoise 的 Readline 实现

支持的平台

  • 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 = "14.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 移动到下一个char的出现
F 移动到上一个char的出现
h, Ctrl-H, Backspace 向左移动一个字符
l, Space 向右移动一个字符
Ctrl-L 清屏
i 在光标前插入
I 在行首插入
+,j,Ctrl-N 向前移动一个历史命令
-,k,Ctrl-P 向后移动一个历史命令
p 在光标处插入剪切的内容(粘贴)
P 在光标前插入剪切的内容
r 替换光标下的单个字符(不离开命令模式)
s 删除光标下的单个字符并进入输入模式
S 更改当前行(等同于0c$)
t 向右移动到下一个char的出现,然后向后移动一个字符
T 向左移动到上一个char的出现,然后向前移动一个字符
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

类似的项目

语言 操作系统 终端 Unicode 历史 完成项 键映射 删除环 撤销 颜色 提示/自动建议
go-prompt Go Ux/win ANSI 任何 Emacs/程序
Haskeline Haskell Ux/Win 任何 任何 Emacs/vi/conf ? ?
isocline C Ux/Win ANSI 任何 Emacs
换行符 Rust Ux/Win 任何 任何 Emacs/conf ?
linenoise C Ux ANSI 只有一行 Emacs Ux
行编辑器 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特质。

依赖项

~290–740KB
~18K SLoC