Struct std::io::Cursor

1.0.0 · source ·

pub struct Cursor<T> { /* private fields */ }

Expand description

Cursor 包装内存中的缓冲区，并为其提供 Seek 实现。

Cursors 与内存缓冲区一起使用，任何实现 AsRef<[u8]>，以允许它们实现 Read 或者 Write，从而允许这些缓冲区在您可能使用进行实际 I/O 的读取器或写入器的任何地方使用。

标准库在通常用作缓冲区的各种类型上实现了一些 I/O traits，例如 Cursor<Vec<u8>> and Cursor<&[u8]>。

Examples

我们可能想在生产代码中将字节写入 File，但在测试中使用内存缓冲区。我们可以做到这一点 Cursor:

use std::io::prelude::*;
use std::io::{self, SeekFrom};
use std::fs::File;

// 我们编写的库函数
fn write_ten_bytes_at_end<W: Write + Seek>(mut writer: W) -> io::Result<()> {
    writer.seek(SeekFrom::End(-10))?;

    for i in 0..10 {
        writer.write(&[i])?;
    }

    // 一切顺利
    Ok(())
}

// 这是一些使用此库函数的代码。
// 我们可能想在此处使用 BufReader 来提高效率，但让我们继续关注此示例。
let mut file = File::create("foo.txt")?;

write_ten_bytes_at_end(&mut file)?;

// 现在让我们编写一个测试
#[test]
fn test_writes_bytes() {
    // 设置一个真实的文件要比内存中的缓冲区慢得多，让我们用游标代替
    use std::io::Cursor;
    let mut buff = Cursor::new(vec![0; 15]);

    write_ten_bytes_at_end(&mut buff).unwrap();

    assert_eq!(&buff.get_ref()[5..15], &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
}

Run

Implementations§

source §

impl<T> Cursor<T>

const: unstable · source

pub fn new(inner: T) -> Cursor<T> ⓘ

创建一个新的游标来包装所提供的底层内存缓冲区。

即使底层缓冲区 (例如 Vec) 不为空，游标的初始位置也为 0。因此，写入游标是从覆盖 Vec 内容开始的，而不是追加到它的上面。

Examples

use std::io::Cursor;

let buff = Cursor::new(Vec::new());

Run

source

pub fn into_inner(self) -> T

消费这个游标，返回底层值。

Examples

use std::io::Cursor;

let buff = Cursor::new(Vec::new());

let vec = buff.into_inner();

Run

const: unstable · source

pub fn get_ref(&self) -> &T

获取此游标中的底层值的引用。

Examples

use std::io::Cursor;

let buff = Cursor::new(Vec::new());

let reference = buff.get_ref();

Run

source

pub fn get_mut(&mut self) -> &mut T

获取此游标中底层值的可变引用。

应注意避免修改底层值的内部 I/O 状态，因为它可能破坏此游标的位置。

Examples

use std::io::Cursor;

let mut buff = Cursor::new(Vec::new());

let reference = buff.get_mut();

Run

const: unstable · source

pub fn position(&self) -> u64

返回此游标的当前位置。

Examples

use std::io::Cursor;
use std::io::prelude::*;
use std::io::SeekFrom;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.position(), 0);

buff.seek(SeekFrom::Current(2)).unwrap();
assert_eq!(buff.position(), 2);

buff.seek(SeekFrom::Current(-1)).unwrap();
assert_eq!(buff.position(), 1);

Run

source

pub fn set_position(&mut self, pos: u64)

设置此游标的位置。

Examples

use std::io::Cursor;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.position(), 0);

buff.set_position(2);
assert_eq!(buff.position(), 2);

buff.set_position(4);
assert_eq!(buff.position(), 4);

Run

source §

impl<T> Cursor<T>where T: AsRef<[u8]>,

source

pub fn remaining_slice(&self) -> &[u8] ⓘ

🔬This is a nightly-only experimental API. (cursor_remaining #86369)

返回剩余的三个。

Examples

#![feature(cursor_remaining)]
use std::io::Cursor;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.remaining_slice(), &[1, 2, 3, 4, 5]);

buff.set_position(2);
assert_eq!(buff.remaining_slice(), &[3, 4, 5]);

buff.set_position(4);
assert_eq!(buff.remaining_slice(), &[5]);

buff.set_position(6);
assert_eq!(buff.remaining_slice(), &[]);

Run

source

pub fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (cursor_remaining #86369)

如果剩余的 3 为空，则返回 true。

Examples

#![feature(cursor_remaining)]
use std::io::Cursor;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

buff.set_position(2);
assert!(!buff.is_empty());

buff.set_position(5);
assert!(buff.is_empty());

buff.set_position(10);
assert!(buff.is_empty());