挖掘 Rust -- 文件读写

注：因为 Rust 有些结构重名，读起来不容易理解，本文解释部分不会省略任何一个 std 命名空间

示例

用途

以行为单位读写文件

代码及输出

use std::fs::File;
use std::io;
use std::io::prelude::*;
use std::io::BufReader;

fn main() -> io::Result<()> {
    let path: &str = "lines.txt";

    let mut output: File = File::create(path)?;
    write!(output, "Rust\n:)\nFun");

    let input: File = File::open(path)?;
    let buffered: BufReader = BufReader::new(input);

    for line in buffered.lines().map(|x| x.unwrap()) {
        // line: String     x:Result
        println!("{}", line);
    }

    Ok(())
}

输出

Rust
:)
Fun

本段代码中可能存在的疑问有

• 什么是
  • std::io::prelude
  • std::io::Result
  • std::io::BufReader
  • write!
• 为什么
  • File output 需要 mut 关键字，而 input 不需要？(此处存在争议，后续补充)
  • 没有手动关闭文件，不会发生资源泄漏吗？

解释

std::io::prelude

std::io::prelude 是一个模块，包含了许多对 I/O 有用的 trait。不同于 std::prelude，std::io::prelude 需要被显示 use。
std::io::prelude 会导出如下 trait

pub use std::io::Read;
pub use std::io::Write;
pub use std::io::BufRead;
pub use std::io::Seek;

补充，和本段无关
std::prelude 会导出如下内容

pub use marker::{Copy, Send, Sized, Sync};
pub use ops::{Drop, Fn, FnMut, FnOnce};
pub use mem::drop;
pub use boxed::Box;
pub use borrow::ToOwned;
pub use clone::Clone;
pub use cmp::{PartialEq, PartialOrd, Eq, Ord};
pub use convert::{AsRef, AsMut, Into, From};
pub use default::Default;
pub use iter::{Iterator, Extend, IntoIterator};
pub use iter::{DoubleEndedIterator, ExactSizeIterator};
pub use option::Option::{self, Some, None};
pub use result::Result::{self, Ok, Err};
pub use slice::SliceConcatExt;
pub use string::{String, ToString};
pub use vec::Vec;

std::io::Result

std::io::Result 是一个类型别名，std::io::Result 是一个类型别名，是一种专为 I/O 设计的 std::result::Result。,std::io 中所有可能出错的函数都会用该类型返回结果。
type Result = Result

为什么用它而不用 std::result::Result

因为 std::io 中的函数返回的错误类型总在 std::io::Error 这个枚举中，总是要写出 std::result::Result 显得繁琐。

命名空间习惯

std::result::Result 是会被 std::prelude 默认导出的（见上节），为了避免混淆，通常会 use std::io 然后用 io::Result 来指代 std::io::Result。通过这种方式把它和 std::result::Result 区分开。

I/O 都会出现什么错误呢?

详见 std::io::ErrorKind

还有其他的这种 Result 类型别名吗?

另一种常用的 Result 类型别名是 std::fmt::Result

std::io::BufReader

直接调用 Read 实例上的读取函数效率比较低（比如，每次在 TcpStream 上的读取都会发起一个系统调用）。如果你想在内存中创建一个缓存区来加快读取效率的话，只需要用 BufReader::new 就能将一个实现了 Read 的实例转化为带有缓冲区的 BufReader。
BufReader 是实现了 BufRead 这个 trait 的结构，BufRead 实现了一个 read_lines 方法。
与之对比的是，std::io::Read 中仅有 bytes 和 chars，因而不能直接被用来以行为单位读取文件。

write!

write! 宏用来向实现了 Write 这个 trait 的实体中写入格式化数据。
因为 impl Write for Vec 存在于 std::vec::Vec 中，我们也可以利用这个宏向其中写入数据。
注意 u8

use std::io::Write;

fn main() {
  let mut w = Vec::new();
  write!(&mut w, "test").unwrap();
  write!(&mut w, "formatted {}", "arguments").unwrap();

  assert_eq!(w, b"testformatted arguments");
}

为什么 File output 需要 mut 关键字，而 input 不需要？

存疑，我会在稍后确定答案后加在这里。

为什么不需要手动关闭文件？

File 类型具有文件资源的所有权，当它离开作用域时，文件将被自动关闭。