https://github.com/SergioBenitez/RustFS

A virtual file system written in Rust.
https://github.com/SergioBenitez/RustFS

Last synced: 6 days ago
JSON representation

A virtual file system written in Rust.

• Host: GitHub
• URL: https://github.com/SergioBenitez/RustFS
• Owner: SergioBenitez
• Archived: true
• Created: 2014-05-13T16:20:23.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-05-26T22:03:30.000Z (over 5 years ago)
• Last Synced: 2024-09-27T07:20:14.871Z (about 2 months ago)
• Language: Rust
• Size: 830 KB
• Stars: 130
• Watchers: 4
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
RustFS

======

RustFS is a virtual file system written completely in Rust.

Usage

-----

Add RustFS to your dependencies:

```toml

[dependencies]

rustfs = { git = "https://github.com/SergioBenitez/RustFS" }

```

Then, import the crate into your project and bring types into the namespace:

```rust

extern crate rustfs;

use rustfs::{Proc, O_CREAT, O_RDWR};

```

Finally, use `Proc::new()` to create a new `Proc`. Call `open` / `close` /

`seek` / `read` / `write` on it:

```rust

let mut p = Proc::new();

// Let's write `data` to a new file named "file".

let data = b"... some data ...";

  let fd = p.open("file", O_CREAT | O_RDWR);

  p.write(fd, &data);

  p.close(fd);

  // Let's read back that data to a buffer named `buf` of the correct size.

  let mut buf = vec![0; size];

  let fd = p.open("file", O_RDWR);

  p.read(fd, &mut buf);

  p.close(fd);

  // All done. Unlink.

p.unlink("file");

```

For more examples on how to use RustFS, see the benchmarks in bench/bench.rs and

tests in src/proc.rs.

Testing

-------

Run the tests using `RUST_TEST_THREADS=1 cargo test`. The tests need to be run

sequentially.

Benchmarking

------------

You'll need Rust nightly to run the benchmarks. We use a custom built

benchmarking tool to get accurate results, and that benchmarking tool uses

assembly. Assembly can only be used in Rust nightly.

To run the benchmarks, switch into the `bench` directory:

```sh

cd bench

```

Run them with Cargo:

```sh

cargo run --release

```

Directory Structure

-------------------

* bench/

  * bench.rs _The benchmarks._

* libbench/lib.rs _The benchmarking library._

* libslab/lib.rs _The slab allocator library._

* src/

  * directory.rs _Insert/Remove/Get directory method implementations._

  * file.rs _FileHandle implementation and structure definitions._

  * inode.rs _Inode structure and implementation._

  * proc.rs _Proc structure (which wraps everything) and implementation._