madsim 0.2.34

Deterministic Simulator for distributed systems.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Asynchronous file system.

use std::{
    fs::Metadata,
    io::{Result, SeekFrom},
    path::Path,
};

pub use tokio::fs::{metadata, read};
use tokio::io::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};

/// A reference to an open file on the filesystem.
pub struct File {
    inner: tokio::fs::File,
}

impl File {
    /// Attempts to open a file in read-only mode.
    pub async fn open(path: impl AsRef<Path>) -> Result<File> {
        Ok(File {
            inner: tokio::fs::File::open(path).await?,
        })
    }

    /// Opens a file in write-only mode.
    ///
    /// This function will create a file if it does not exist, and will truncate it if it does.
    pub async fn create(path: impl AsRef<Path>) -> Result<File> {
        Ok(File {
            inner: tokio::fs::File::create(path).await?,
        })
    }

    /// Reads a number of bytes starting from a given offset.
    pub async fn read_at(&mut self, buf: &mut [u8], offset: u64) -> Result<usize> {
        // TODO: make it &self
        self.inner.seek(SeekFrom::Start(offset)).await?;
        let len = self.inner.read(buf).await?;
        Ok(len)
    }

    /// Attempts to write an entire buffer starting from a given offset.
    pub async fn write_all_at(&mut self, buf: &[u8], offset: u64) -> Result<()> {
        // TODO: make it &self
        self.inner.seek(SeekFrom::Start(offset)).await?;
        self.inner.write_all(buf).await?;
        Ok(())
    }

    /// Truncates or extends the underlying file, updating the size of this file to become `size`.
    pub async fn set_len(&self, size: u64) -> Result<()> {
        self.inner.set_len(size).await
    }

    /// Attempts to sync all OS-internal metadata to disk.
    pub async fn sync_all(&self) -> Result<()> {
        self.inner.sync_all().await
    }

    /// Queries metadata about the underlying file.
    pub async fn metadata(&self) -> Result<Metadata> {
        self.inner.metadata().await
    }
}