RustyLine

Rust 中基于 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 = "12.0.0"

功能

• Unicode（UTF-8）（linenoise 仅支持 ASCII）
• 单词补全（linenoise 仅支持行补全）
• 文件名补全
• 历史搜索（在历史中搜索命令）
• 删除环（删除命令）
• 多行支持（换行）
• 单词命令
• 提示

操作

对所有模式

Emacs模式（默认模式）

Readline Emacs编辑模式速查表

vi命令模式

vi插入模式

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

类似项目

多行支持

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

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

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