Skip to main content

FilesystemCore

Struct FilesystemCore 

Source
pub struct FilesystemCore { /* private fields */ }
Expand description

The main filesystem core. Owns the block store, crypto, codec, allocator, and transaction manager. Provides high-level filesystem operations.

All path-accepting methods use /-separated paths. An empty string or "/" refers to the root directory. Parent directories must already exist; only create_file and create_directory create the leaf entry.

Implementations§

Source§

impl FilesystemCore

Source

pub fn new(store: Arc<dyn BlockStore>, crypto: Arc<dyn CryptoEngine>) -> Self

Create a new FilesystemCore backed by the given store and crypto engine.

Examples found in repository?
examples/create_image.rs (line 33)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}
More examples
Hide additional examples
examples/network_mount.rs (line 84)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn init_filesystem(&mut self) -> FsResult<()>

Initialize a brand-new filesystem on the block store. Writes the storage header, creates the root directory, and commits.

Examples found in repository?
examples/create_image.rs (line 35)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}
More examples
Hide additional examples
examples/network_mount.rs (line 89)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn open(&mut self) -> FsResult<()>

Open / mount an existing filesystem by recovering the latest root pointer.

Examples found in repository?
examples/network_mount.rs (line 92)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn create_file(&mut self, path: &str) -> FsResult<()>

Create a new empty file at the given path.

Parent directories must already exist. The leaf name is created in the innermost directory.

Examples found in repository?
examples/create_image.rs (line 38)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}
More examples
Hide additional examples
examples/network_mount.rs (line 97)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn write_file( &mut self, path: &str, offset: u64, data: &[u8], ) -> FsResult<()>

Write data to a file at the given path.

Only the chunks that overlap with [offset, offset+data.len()) are read and rewritten. For sequential appends this means O(new_data) work instead of O(file_size).

Examples found in repository?
examples/create_image.rs (line 39)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}
More examples
Hide additional examples
examples/network_mount.rs (line 102)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn read_file( &self, path: &str, offset: u64, len: usize, ) -> FsResult<Vec<u8>>

Read file data at the given path. Returns the requested slice.

Examples found in repository?
examples/network_mount.rs (line 105)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn list_directory(&self, path: &str) -> FsResult<Vec<DirListEntry>>

List entries in a directory at the given path.

Pass "" or "/" to list the root directory.

Examples found in repository?
examples/network_mount.rs (line 109)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}
Source

pub fn create_directory(&mut self, path: &str) -> FsResult<()>

Create a subdirectory at the given path.

Parent directories must already exist; only the leaf is created.

Examples found in repository?
examples/create_image.rs (line 43)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}
Source

pub fn remove_file(&mut self, path: &str) -> FsResult<()>

Remove a file or empty directory at the given path.

Source

pub fn rename(&mut self, old_path: &str, new_path: &str) -> FsResult<()>

Rename a file or directory. Both old_path and new_path must share the same parent directory (move across directories is not supported yet).

Source

pub fn sync(&self) -> FsResult<()>

Sync / flush. Calls through to the block store sync.

Examples found in repository?
examples/create_image.rs (line 52)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}
More examples
Hide additional examples
examples/network_mount.rs (line 117)
21fn main() {
22    let args: Vec<String> = std::env::args().collect();
23
24    let mut addr = "127.0.0.1:9100";
25    let mut server_name = "localhost";
26    let mut ca = "certs/ca.pem";
27    let mut master_key_hex = "";
28    let mut init = false;
29
30    let mut i = 1;
31    while i < args.len() {
32        match args[i].as_str() {
33            "--addr" => {
34                addr = &args[i + 1];
35                i += 2;
36            }
37            "--server-name" => {
38                server_name = &args[i + 1];
39                i += 2;
40            }
41            "--ca" => {
42                ca = &args[i + 1];
43                i += 2;
44            }
45            "--master-key" => {
46                master_key_hex = &args[i + 1];
47                i += 2;
48            }
49            "--init" => {
50                init = true;
51                i += 1;
52            }
53            other => {
54                eprintln!("unknown argument: {other}");
55                std::process::exit(1);
56            }
57        }
58    }
59
60    if master_key_hex.is_empty() || master_key_hex.len() != 64 {
61        eprintln!("--master-key must be a 64-character hex string (32 bytes)");
62        std::process::exit(1);
63    }
64
65    let master_key: Vec<u8> = (0..32)
66        .map(|i| u8::from_str_radix(&master_key_hex[i * 2..i * 2 + 2], 16).unwrap())
67        .collect();
68
69    // ── Connect ─────────────────────────────────────────────
70    println!("Connecting to {addr} (SNI: {server_name})...");
71    let net = NetworkBlockStore::connect(addr, server_name, Path::new(ca), &master_key)
72        .expect("failed to connect to server");
73
74    println!(
75        "Connected: {} blocks × {} bytes ({} MiB)",
76        net.total_blocks(),
77        net.block_size(),
78        net.total_blocks() as usize * net.block_size() / (1024 * 1024)
79    );
80
81    // ── Wrap with cache ─────────────────────────────────────
82    let store = Arc::new(CachedBlockStore::new(net, 1024));
83    let crypto = Arc::new(ChaChaEngine::new(&master_key).expect("invalid master key"));
84    let mut fs = FilesystemCore::new(store.clone(), crypto);
85
86    // ── Mount or init ───────────────────────────────────────
87    if init {
88        println!("Initializing new filesystem...");
89        fs.init_filesystem().expect("init_filesystem failed");
90    } else {
91        println!("Mounting existing filesystem...");
92        fs.open().expect("open failed");
93    }
94
95    // ── Demo operations ─────────────────────────────────────
96    println!("\nCreating file 'hello.txt'...");
97    match fs.create_file("hello.txt") {
98        Ok(()) => {}
99        Err(e) => println!("  (skipped: {e})"),
100    }
101
102    fs.write_file("hello.txt", 0, b"Hello from the network!")
103        .expect("write failed");
104
105    let data = fs.read_file("hello.txt", 0, 4096).expect("read failed");
106    println!("Read back: {:?}", String::from_utf8_lossy(&data));
107
108    println!("\nListing root directory:");
109    for entry in fs.list_directory("").expect("list failed") {
110        println!(
111            "  {:?}  {:>10} bytes  {}",
112            entry.kind, entry.size, entry.name
113        );
114    }
115
116    // ── Sync ────────────────────────────────────────────────
117    fs.sync().expect("sync failed");
118    println!("\nAll data synced to server.");
119}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V