Xed编辑器开发第一期:使用Rust从0到1写一个文本编辑器

  • 这是一个使用Rust实现的轻量化文本编辑器。
  • 学过Rust的都知道，Rust 从入门到实践中间还隔着好几个Go语言的难度，因此，如果你也正在学习Rust,那么恭喜你，这个项目被你捡到了。
  • 本项目内容较多，大概会分三期左右陆续发布，欢迎关注！

1. 第一篇

本系列教程默认你已经配置了Rust开发环境并具有一定的rust基础。所以直接从项目创建开始讲解；

使用下面的命令创建项目

  • 项目创建
cargo new xed
  • 运行程序
cargo run

如果成功输出Hello World表示项目基本功能正常，本章节完！

2. 第二篇

2.1 读取用户输入

现在修改main.rs，尝试读取用户的输入，你可以随时按下Ctrl + c终止程序；

use std::io;
use std::io::Read;
fn main() {let mut buf = [0; 1];while io::stdin().read(&mut buf).expect("Failed to read line") == 1 {}
}
  • 这里的内容不多，主要涉及到io的基本操作，所以导包是必要的；
  • 第4行创建了一个可变的buf数组，长度为1，初始值为0;
  • io::stdin().read(&mut buf) 尝试从标准输入流中读取数据，并将其存储在 buf 中。read 方法返回一个 Result 类型，其中包含读取的字节数或一个错误。
  • 所以expect("Failed to read line") 用于处理可能出现的错误情况。如果读取失败，程序将打印出 “Failed to read line” 作为错误信息并终止程序。
  • 最后的==1检查读取的字节数是否为1，否则结束循环；

2.2 实现q命令

本小节实现基本功能:用户输入q按下回车执行退出程序的操作。

use std::io;
use std::io::Read;
fn main() {let mut buf = [0; 1];while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf !=[b'q'] {}
}
  • 程序会检查buf中输入的每一个字符，如果与q相同，就会结束程序；

在 Rust 中，[b'q'] 是一个字节字符串字面量，表示一个包含单个字节 q 的字节数组。

  1. [b'q']：

    • b'q' 是 Rust 中的字节字面量，表示一个字节，即 ASCII 字符 'q' 对应的字节值。
    • 在 Rust 中，使用 b 前缀可以将字符转换为对应的字节值。这种表示方式常用于处理字节数据。

  2. 字节值和字符映射：

    • 在 ASCII 编码中，每个字符都有一个对应的字节值。在 ASCII 编码中，字符 'q' 对应的字节值是 113。
    • 使用 b'q' 可以直接表示这个字节值，而 [b'q'] 则将这个字节值包装在一个长度为 1 的字节数组中。

因此，[b'q'] 表示一个包含单个字节值为 113（即 ASCII 字符 'q' 对应的字节值）的字节数组。在上下文中，buf != [b'q'] 的条件判断将检查 buf 中存储的字节是否不等于 'q' 对应的字节值，即检查输入的数据是否不是 'q'。

  • 等价写法:buf[0] != b'q'

2.3 常规模式与原始模式

上面的情况就是常规模式，也就是程序启动后终端可以正常监听并回显你输入的内容；

而这里说的原始模式的作用和常规模式相反，我们这里可以直接使用crossterm库来实现，添加依赖：

cargo add crossterm

use std::io;
use std::io::Read;
use crossterm::terminal; // 添加依赖
fn main() {terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式let mut buf = [0; 1];while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {}
}

现在如果你运行程序，你的输入在终端并没有任何回显，并且当你输入q的时候也是直接无提示的退出程序，这就是crossterm帮我们实现的原始模式的基本功能；

如果要禁用原始模式，考虑下面的代码，最后一行就是禁用这个模式的逻辑；

use crossterm::terminal; /* add this line */
use std::io;
use std::io::Read;
fn main() {terminal::enable_raw_mode().expect("Could not turn on Raw mode");let mut buf = [0; 1];while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {}terminal::disable_raw_mode().expect("Could not turn off raw mode"); /* add this line */
}

但是这样运行后会出现一个错误：

当在 terminal::enable_raw_mode() 之后的函数中发生错误并导致 panic 时，disable_raw_mode() 将不会被调用，导致终端保持在原始模式。这种情况可能会导致程序结束时终端状态不正确，用户体验受到影响。

所以为了解决这个问题，让我们创建 一个 名为 CleanUp的struct;

struct CleanUp;impl Drop for CleanUp {fn drop(&mut self) {terminal::disable_raw_mode().expect("Could not disable raw mode");}
}

然后修改原来的代码：

use crossterm::terminal; // 添加依赖
use std::io;
use std::io::Read;
struct CleanUp;impl Drop for CleanUp {fn drop(&mut self) {terminal::disable_raw_mode().expect("Could not disable raw mode");}
}fn main() {let _clean_up = CleanUp; // 看这里terminal::enable_raw_modde().expect("Could not run on Raw mode"); // 开启原始模式let mut buf = [0; 1];while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {}// terminal::disable_raw_mode().expect("Could not turn off raw mode"); /* add this line */panic!(""); // 看这里
}

  • 现在我们新增了一个struct并实现了Drop这个trait;此时drop()函数会在我们的struct实例，也就是_clean_up超出作用域或者该实例出现panic时候执行；

  • 一旦上面的情况发生，drop()被执行，那么将成功禁用原始模式；

但是现在还有问题，此时使用Ctrl +c 无法退出程序；不妨看看当我们按下这些按键的时候输出了什么东西；

fn main() {let _clean_up = CleanUp;terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式let mut buf = [0; 1];while io::stdin().read(&mut buf).expect("Failed to read line") == 1 && buf != [b'q'] {let character = buf[0] as char;if character.is_control() {println!("{}\r", character as u8)} else {println!("{}\r", character)}}
}
  • is_control()判断按下的是否为控制键位，在正常情况下，控制键位输入的字符我们并不需要；
  • ASCII的0-31都是控制字符，127也是；
  • 所以32-126就是可打印的字符，也是我们在编辑文本时需要进行输入回显的；
  • 另外，请注意我们在打印信息的时候使用的是\r而不是\n;此时我们在终端输入数据之后，光标会自动调整到屏幕的左侧。

现在请运行程序并尝试按下控制键位，例如方向键、 或 Escape 、 或 Page Up Page Down 、 Home End Backspace Delete 或 Enter 或 。尝试使用 Ctrl 组合键，如 Ctrl-A、Ctrl-B 等。你会发现：

  • 方向键：Page Up、Page Down、Home 和 End 都向终端输入 3 或 4 个字节： 27 、、 '[' ，然后是一两个其他字符。这称为转义序列。所有转义序列都以 27 字节开头。按 Escape 键发送单个 27 字节作为输入。

  • Backspace 是字节 127 。Delete 是一个 4 字节的转义序列。

  • Enter 是 byte 10 ，这是一个换行符，也称为 '\n' 或 byte 13 ，这是回车符，也称为 \r 。

  • 另外：Ctrl-A 是 1 ， Ctrl-B 是 2 ， Ctrl-C 是3…这确实有效的 将Ctrl 组合键将字母 A-Z 映射到代码 1-26

通过上面的步骤，我们基本了解了按键是如何转为字节的。

2.4 crossterm提供的事件抽象

crossterm 还提供了对各种关键事件的抽象，因此我们不必记住上面那一堆映射关系；而是使用这个crate带来的实现方法；

下面是使用这些抽象重构之火的main.rs:

use crossterm::event::{Event, KeyCode, KeyEvent};
use crossterm::{event, terminal}; // 添加依赖
use std::io;
use std::io::Read;
struct CleanUp;impl Drop for CleanUp {fn drop(&mut self) {terminal::disable_raw_mode().expect("Could not disable raw mode");}
}fn main() {let _clean_up = CleanUp;terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式let mut buf = [0; 1];// 从这里开始重构loop {if let Event::Key(event) = event::read().expect("Failed to read line") {match event {KeyEvent {code: KeyCode::Char('q'),modifiers: event::KeyModifiers::NONE,kind: event::KeyEventKind::Press,state: event::KeyEventState::NONE,} => break,_ => {// todo}}println!("{:?}\r", event);};}
}
  • Event 是一个 enum 。由于我们目前只对按键感兴趣，因此我们检查返回的 Event 键是否为 Key .然后，我们检查按下的键是否为 q 。如果用户按下 q ，我们就会中断 loop ，程序将终止。
  • 当然，枚举中其他几个字段也是必须的，参考下文档中枚举的定义如下:
pub struct KeyEvent {pub code: KeyCode,pub modifiers: KeyModifiers,pub kind: KeyEventKind,pub state: KeyEventState,
}

其中的kind也是枚举：

pub enum KeyEventKind {Press,Repeat,Release,
}

sate的定义：

    pub struct KeyEventState: u8 {/// The key event origins from the keypad.const KEYPAD = 0b0000_0001;/// Caps Lock was enabled for this key event.////// **Note:** this is set for the initial press of Caps Lock itself.const CAPS_LOCK = 0b0000_1000;/// Num Lock was enabled for this key event.////// **Note:** this is set for the initial press of Num Lock itself.const NUM_LOCK = 0b0000_1000;const NONE = 0b0000_0000;}

看着有点怕但是不要怕，当下只需要理解代码中按下q执行程序退出的逻辑就可以。

下面是一个示例输出，它会在你按下按键的时候记录并打印相关的事件信息。你可以测试一下按下q是否正常退出程序。

image-20240514221935305

2.4 超时处理

现在的情况是，read()会无限期的在等待我们的键盘输入后返回。如果我们一直没有输入，那它就已知等待，这是个问题。因此我们需要有一个超时处理的逻辑，比如超过一定时间没用户没有任何操作就执行超时对应的处理逻辑。

use crossterm::event::{Event, KeyCode, KeyEvent};
use crossterm::{event, terminal}; // 添加依赖
use std::io;
use std::io::Read;
use std::time::Duration; // 新增依赖
struct CleanUp;impl Drop for CleanUp {fn drop(&mut self) {terminal::disable_raw_mode().expect("Could not disable raw mode");}
}fn main() {let _clean_up = CleanUp;terminal::enable_raw_mode().expect("Could not run on Raw mode"); // 开启原始模式let mut buf = [0; 1];// 从这里开始重构loop {if event::poll(Duration::from_millis(500)).expect("Program timed out") { // 超时处理if let Event::Key(event) = event::read().expect("Failed to read line") {match event {KeyEvent {code: KeyCode::Char('q'),modifiers: event::KeyModifiers::NONE,kind: event::KeyEventKind::Press,state: event::KeyEventState::NONE,} => break,_ => {// todo}}println!("{:?}\r", event);};}}
}

上面的代码中新增的超时处理中用到了crossterm::event::poll这个方法，如果在给定时间内没有 Event 可用， poll 则返回 false ,具体的函数定义信息如下：

image-20240515084930391

2.5 错误处理

一路走来，我们对程序的错误处理都是使用expect()进行简单的捕获，这显然并不是一个很好的选择和习惯，下面通过使用Result来对错误进行进一步的处理，修改main.rs:

use crossterm::event::{Event, KeyCode, KeyEvent};
use crossterm::{event, terminal};
use std::time::Duration; /* add this line */struct CleanUp;impl Drop for CleanUp {fn drop(&mut self) {terminal::disable_raw_mode().expect("Unable to disable raw mode")}
}fn main() -> std::result::Result<(), std::io::Error> {let _clean_up = CleanUp;terminal::enable_raw_mode()?;loop {if event::poll(Duration::from_millis(500))? {if let Event::Key(event) = event::read()? {match event {KeyEvent {code: KeyCode::Char('q'),modifiers: event::KeyModifiers::NONE,kind: _,state: _,} => break,_ => {//todo}}println!("{:?}\r", event);};} else {println!("No input yet\r");}}Ok(())
}

修改部分如下,注意，对于main方法本身也是指定了返回值类型，这在下面的贴图中没有展现。

image-20240515090210813

  • ? 算符只能用于返回 Result 的方法中，因此 Option 我们必须修改 our main() 以返回 Result .可以 crossterm::Result<T> 扩展为 std::result::Result<T, std::io::Error>

  • 因此，对于我们的 main() 函数，返回类型可以转换为 std::result::Result<(), std::io::Error> 。

本期完,下期内容抢先知:

  • Ctrl+Q退出
  • 键盘输入重构
  • 屏幕清理
  • 光标定位
  • 退出清屏
  • 波浪号占位符(类似于vim)
  • 追加缓冲区

写在最后：

如果这篇内容跟下来，你还是觉得比较难，那么我推荐你暂时放一下，这里推荐一个我之前写的开源项目untools,这也是一个使用Rust编写的工具库，可以拿来练手，顺手点个star的同时也欢迎有想法有能力的同学PR;
在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若转载，请注明出处：http://www.tpcf.cn/bicheng/12883.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

NAS导航面板Sun-Panel

NAS导航面板Sun-Panel

什么是 Sun-Panel &#xff1f; Sun-Panel 是一个服务器、NAS 导航面板、Homepage、浏览器首页。 软件主要特点&#xff1a; &#x1f349; 界面简洁&#xff0c;功能强大&#xff0c;资源消耗低&#x1f34a; 简单易用&#xff0c;可视化操作&#xff0c;零代码使用&#x1f…
阅读更多...
python怎么安装matplotlib

python怎么安装matplotlib

1、登陆官方网址“https://pypi.org/project/matplotlib/#description”&#xff0c;下载安装包。 2、选择合适的安装包&#xff0c;下载下来。 3、将安装包放置到python交互命令窗口的当前目录下。 4、打开windows的命令行窗口&#xff0c;通过"pip install"这个命令…
阅读更多...
cgicc开发 (结合sqlite3操作数据库)

cgicc开发 (结合sqlite3操作数据库)

#include <iostream> #include <fstream> //读写文件 c标准库 #include <string> //字符串类 c标准库 #include <sstream> //字符串流 c标准库 #include <assert.h> #include "sqlite3.h" //sqlite3头文件#include <cgicc/CgiDefs.…
阅读更多...
新质生产力之工业互联网产业链

新质生产力之工业互联网产业链

随着全球经济的数字化转型&#xff0c;新基建的概念逐渐成为推动工业发展的关键动力。在这一转型过程中&#xff0c;工业互联网作为新基建的核心组成部分&#xff0c;正逐渐塑造着未来工业的面貌。那么工业互联网产业链是如何构成的&#xff0c;以及它如何成为推动工业4.0和智能…
阅读更多...
PyQt6--Python桌面开发（15.QRadioButton单选按钮控件）

PyQt6--Python桌面开发（15.QRadioButton单选按钮控件）

QRadioButton单选按钮控件
阅读更多...
CRMEB开源打通版/标准版v4电商商城系统小程序发布之后无法生成海报问题

CRMEB开源打通版/标准版v4电商商城系统小程序发布之后无法生成海报问题

小程序产品分销二维码生成不了 开发者工具可以生成海报&#xff0c;但是发布之后无法生成 1.在开发者工具中&#xff0c;将不校验合法域名关闭 2.点击生成海报&#xff0c;查看console 3.将域名填写到微信公众平台小程序的download合法域名中 网址微信公众平台
阅读更多...
MQTT入门_1_资料

MQTT入门_1_资料

MQTT&#xff08;Message Queuing Telemetry Transport&#xff0c;消息队列遥测传输协议&#xff09;是一种轻量级的消息协议&#xff0c;设计用于有限的带宽和不稳定网络上&#xff0c;它工作在发布/订阅&#xff08;publish/subscribe&#xff09;模式。MQTT最初由IBM开发&a…
阅读更多...
react18【系列实用教程】memo —— 缓存组件 （2024最新版）

react18【系列实用教程】memo —— 缓存组件 （2024最新版）

memo 的语法 如上图所示&#xff0c;在react中&#xff0c;当父组件重新渲染时&#xff0c;子组件也会重新渲染&#xff0c;即便子组件无任何变化&#xff0c;通过 memo 可以实现对组件的缓存&#xff0c;即当子组件无变化时&#xff0c;不再重新渲染子组件&#xff0c;核心代码…
阅读更多...
Python 简易图书管理系统

Python 简易图书管理系统

## 环境准备 确保你已经安装了 Python 和 Flask。同时&#xff0c;安装 SQLAlchemy 作为 ORM 工具&#xff0c;以及 Flask-Migrate 用于数据库迁移。 bash pip install Flask pip install Flask-SQLAlchemy pip install Flask-Migrate ## Flask 应用结构 我们的 Flask 应…
阅读更多...
【深度学习】Diffusion扩散模型的逆扩散问题

【深度学习】Diffusion扩散模型的逆扩散问题

1、前言 上一篇&#xff0c;我们讲了Diffusion这个模型的原理推导。但在推导中&#xff0c;仍然遗留了一些问题。本文将解决那些问题 参考论文&#xff1a; ①Variational Diffusion Models (arxiv.org) ②Tutorial on Diffusion Models for Imaging and Vision (arxiv.org…
阅读更多...
迭代的难题：敏捷团队每次都有未完成的工作，如何破解？

迭代的难题：敏捷团队每次都有未完成的工作，如何破解？

各位是否遇到过类似的情况&#xff1a;每次迭代结束后&#xff0c;团队都有未完成的任务&#xff0c;很少有完成迭代全部的工作&#xff0c;相反&#xff0c;总是将上期未完成的任务重新挪到本期计划会中&#xff0c;重新规划。敏捷的核心之一是“快速迭代&#xff0c;及时反馈…
阅读更多...
ubuntu20.04 ROS 环境下使用速腾80线激光雷达

ubuntu20.04 ROS 环境下使用速腾80线激光雷达

1.相关系统环境 系统版本:ubuntu 20.04 ROS版本&#xff1a;ROS1 - noetic 激光雷达型号&#xff1a;RoboSense Ruby &#xff08;更新于2024.5.14&#xff09; 2.网口配置&#xff1a; 将PC/工控机的网口配置为&#xff1a; ipv4&#xff0c;方式设置为手动 ip地址、掩码以…
阅读更多...
LGadb找不到设备，解决方法：安装驱动

LGadb找不到设备，解决方法：安装驱动

解决方法&#xff1a;安装驱动 https://www.123pan.com/s/Z6tFjv-JqiPv.html提取码:6666
阅读更多...
基于springboot实现社区智慧养老监护管理平台系统项目【项目源码+论文说明】计算机毕业设计

基于springboot实现社区智慧养老监护管理平台系统项目【项目源码+论文说明】计算机毕业设计

基于SpringBoot实现社区智慧养老监护管理平台系统演示 摘要 如今社会上各行各业&#xff0c;都在用属于自己专用的软件来进行工作&#xff0c;互联网发展到这个时候&#xff0c;人们已经发现离不开了互联网。互联网的发展&#xff0c;离不开一些新的技术&#xff0c;而新技术的…
阅读更多...
EE-SX670 槽型光电开关 5MM 限位检测感应器 使用案例

EE-SX670 槽型光电开关 5MM 限位检测感应器 使用案例

EE-SX670是一款槽型光电开关&#xff0c;也被称为U形传感器或限位检测感应器。它是光电传感器中的一种&#xff0c;通过检测物体是否插入其感应槽来触发开关。这种传感器通常用于自动化生产线上的位置检测、对象计数以及安全设备中的运动检测。 EE-SX670作为一款高性能的光电传…
阅读更多...
Redis教程(四)：Redis中String类型的常用命令

Redis教程(四)：Redis中String类型的常用命令

String操作&#xff1a; 插入一个key为name&#xff0c;值为apple的数据 set name apple 插入的数据中如果有空格的数据&#xff0c;请用""双引号&#xff0c;否则会报错&#xff01; set name "hello world!" 如果key为name的数据不存在&#xff0c;…
阅读更多...
谷歌外贸seo优化怎么做？

谷歌外贸seo优化怎么做？

一般有两种选择&#xff0c;在大型电商平台开展业务&#xff0c;如亚马逊&#xff0c;阿里巴巴等平台&#xff0c;也可以选择搭建自己的独立站 选择在大型电商平台可以方便迅速建立起自己的商铺&#xff0c;不需要考虑太多交易&#xff0c;支付&#xff0c;物流等方面的问题&am…
阅读更多...
非阻塞模式下的读写操作

非阻塞模式下的读写操作

实现文件IO的非阻塞模式的读写操作 fcntl函数 功能&#xff1a; #include <unistd.h> #include <fcntl.h> int fcntl(int fd, int cmd, ... /* arg */ ); // arg表示可变参数&#xff0c;由cmd决定 fcntl()对打开的文件描述符fd执行下面描述的操作之一。操作由cmd决…
阅读更多...
MybatisPlus拓展功能(内附全功能代码)

MybatisPlus拓展功能(内附全功能代码)

目录 代码生成 静态工具 案例 逻辑删除 枚举处理器 ​编辑 Json处理器 分页插件功能 ​编辑 案例 封装转换方法 代码生成 静态工具 案例 Overridepublic UserVO queryUserAndAddressById(long id) { // 1.查询用户User user getById(id);if (user null || …
阅读更多...
mobarxtem应用与华为设备端口绑定技术

mobarxtem应用与华为设备端口绑定技术

交换机端口绑定 华为交换机的基础配置与MOBAXTERM终端连接 实验步骤&#xff1a; 一、给每个交换机划分vlan并添加端口 1.单个vlan的划分 2.批量划分vlan 在高端交换机CE6800上批量划分连续编号的VLAN&#xff0c;本例中连续的vlan20到vlan25 [~CE6800]vlan b 20 to 25 3…
阅读更多...
最新文章

Copyright @ 2022~2023