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

已删除 rustyline-nightly

非官方的 Rustyline 夜间版本

使用旧的 Rust 2015

2.0.0-alpha-20180628 2018年6月29日

#19 in #rustyline

MIT 许可证

280KB
7.5K SLoC

RustyLine

Build Status Build Status dependency status Docs

RustyLine 是一个基于 Antirez' Linenoise 的 Rust 实现的 Readline 库。

支持的平台

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

注意:

  • Powershell ISE 不受支持,请查看 问题 #56
  • Mintty (Cygwin/Mingw) 不受支持

示例

extern crate rustyline;

use rustyline::error::ReadlineError;
use rustyline::Editor;

fn main() {
    // `()` can be used when no completer is required
    let mut rl = Editor::<()>::new();
    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_ref());
                println!("Line: {}", line);
            },
            Err(ReadlineError::Interrupted) => {
                println!("CTRL-C");
                break
            },
            Err(ReadlineError::Eof) => {
                println!("CTRL-D");
                break
            },
            Err(err) => {
                println!("Error: {:?}", err);
                break
            }
        }
    }
    rl.save_history("history.txt").unwrap();
}

crates.io

您可以在项目中使用此包,只需将以下内容添加到您的 Cargo.toml

[dependencies]
rustyline = "1.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, Left 将光标向左移动一个字符
Ctrl-E, End 将光标移动到行的末尾
Ctrl-F, Right 将光标向右移动一个字符
Ctrl-H, BackSpace 删除光标前的字符
Ctrl-I, Tab 下一个补全
Ctrl-K 从光标删除到行末
Ctrl-L 清除屏幕
Ctrl-N, Down 下一个历史匹配
Ctrl-P, Up 上一个历史匹配
Ctrl-X Ctrl-U 撤销
Ctrl-Y 从剪切板粘贴(使用 Meta-Y 粘贴下一个剪切板内容)
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

类似的项目

语言 操作系统 终端 Unicode 历史记录 完成 键盘映射 删除环 撤销 颜色 提示/自动建议
Haskeline Haskell Unix/Windows 任意 任何 Emacs/Vi/配置 ? ?
Linenoise C Unix ANSI 仅行 Emacs Unix
Linenoise-ng C Unix/Windows ANSI 仅行 Emacs ? ?
换行符 Rust Unix/Windows 任意 任何 Emacs/配置 ?
Liner Rust Unix ANSI 无增量搜索 仅单词 Emacs/Vi/程序 Unix 基于历史
提示工具包 Python Unix/Windows ANSI 任何 Emacs/Vi/配置 Unix/Windows
Rb-readline Ruby Unix/Windows ANSI 仅单词 Emacs/Vi/配置 ?
Replxx C/C++ Unix/Windows ANSI 仅行 Emacs Unix/Windows
Rustyline Rust Unix/Windows ANSI 任何 Emacs/Vi/绑定 Unix/Win 10+

依赖项

~3MB
~46K SLoC