Reworked the examples.

Volume Manager API also now takes things that are "convertible to a short file name", so you can use a ShortFileName, or a &str.

Author: jonathanpallant

CHANGELOG.md

@@ -25,11 +25,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- None
+- New examples, `append_file`, `create_file`, `delete_file`, `list_dir`
+- New test cases `tests/directories.rs`, `tests/read_file.rs`
 
 ### Removed
 
 - __Breaking Change__: `Controller` alias for `VolumeManager` removed.
+- Old examples `create_test`, `test_mount`, `write_test`, `delete_test`
 
 ## [Version 0.5.0](https://github.com/rust-embedded-community/embedded-sdmmc-rs/releases/tag/v0.5.0) - 2023-05-20
 

Cargo.toml

@@ -22,6 +22,7 @@ env_logger = "0.9"
 hex-literal = "0.3"
 flate2 = "1.0"
 sha256 = "1.4"
+chrono = "0.4"
 
 [features]
 default = ["log"]

examples/append_file.rs

@@ -0,0 +1,49 @@
+//! Append File Example.
+//!
+//! ```bash
+//! $ cargo run --example append_file -- ./disk.img
+//! $ cargo run --example append_file -- /dev/mmcblk0
+//! ```
+//!
+//! If you pass a block device it should be unmounted. No testing has been
+//! performed with Windows raw block devices - please report back if you try
+//! this! There is a gzipped example disk image which you can gunzip and test
+//! with if you don't have a suitable block device.
+//!
+//! ```bash
+//! zcat ./tests/disk.img.gz > ./disk.img
+//! $ cargo run --example append_file -- ./disk.img
+//! ```
+
+extern crate embedded_sdmmc;
+
+mod linux;
+use linux::*;
+
+const FILE_TO_APPEND: &str = "README.TXT";
+
+use embedded_sdmmc::{Error, Mode, VolumeIdx, VolumeManager};
+
+fn main() -> Result<(), embedded_sdmmc::Error<std::io::Error>> {
+    env_logger::init();
+    let mut args = std::env::args().skip(1);
+    let filename = args.next().unwrap_or_else(|| "/dev/mmcblk0".into());
+    let print_blocks = args.find(|x| x == "-v").map(|_| true).unwrap_or(false);
+    let lbd = LinuxBlockDevice::new(filename, print_blocks).map_err(Error::DeviceError)?;
+    let mut volume_mgr: VolumeManager<LinuxBlockDevice, Clock, 8, 8, 4> =
+        VolumeManager::new_with_limits(lbd, Clock, 0xAA00_0000);
+    let volume = volume_mgr.open_volume(VolumeIdx(0))?;
+    let root_dir = volume_mgr.open_root_dir(volume)?;
+    println!("\nCreating file {}...", FILE_TO_APPEND);
+    let f = volume_mgr.open_file_in_dir(root_dir, FILE_TO_APPEND, Mode::ReadWriteAppend)?;
+    volume_mgr.write(f, b"\r\n\r\nThis has been added to your file.\r\n")?;
+    volume_mgr.close_file(f)?;
+    volume_mgr.close_dir(root_dir)?;
+    Ok(())
+}
+
+// ****************************************************************************
+//
+// End Of File
+//
+// ****************************************************************************

examples/create_file.rs

@@ -0,0 +1,52 @@
+//! Create File Example.
+//!
+//! ```bash
+//! $ cargo run --example create_file -- ./disk.img
+//! $ cargo run --example create_file -- /dev/mmcblk0
+//! ```
+//!
+//! If you pass a block device it should be unmounted. No testing has been
+//! performed with Windows raw block devices - please report back if you try
+//! this! There is a gzipped example disk image which you can gunzip and test
+//! with if you don't have a suitable block device.
+//!
+//! ```bash
+//! zcat ./tests/disk.img.gz > ./disk.img
+//! $ cargo run --example create_file -- ./disk.img
+//! ```
+
+extern crate embedded_sdmmc;
+
+mod linux;
+use linux::*;
+
+const FILE_TO_CREATE: &str = "CREATE.TXT";
+
+use embedded_sdmmc::{Error, Mode, VolumeIdx, VolumeManager};
+
+fn main() -> Result<(), embedded_sdmmc::Error<std::io::Error>> {
+    env_logger::init();
+    let mut args = std::env::args().skip(1);
+    let filename = args.next().unwrap_or_else(|| "/dev/mmcblk0".into());
+    let print_blocks = args.find(|x| x == "-v").map(|_| true).unwrap_or(false);
+    let lbd = LinuxBlockDevice::new(filename, print_blocks).map_err(Error::DeviceError)?;
+    let mut volume_mgr: VolumeManager<LinuxBlockDevice, Clock, 8, 8, 4> =
+        VolumeManager::new_with_limits(lbd, Clock, 0xAA00_0000);
+    let volume = volume_mgr.open_volume(VolumeIdx(0))?;
+    let root_dir = volume_mgr.open_root_dir(volume)?;
+    println!("\nCreating file {}...", FILE_TO_CREATE);
+    // This will panic if the file already exists: use ReadWriteCreateOrAppend
+    // or ReadWriteCreateOrTruncate instead if you want to modify an existing
+    // file.
+    let f = volume_mgr.open_file_in_dir(root_dir, FILE_TO_CREATE, Mode::ReadWriteCreate)?;
+    volume_mgr.write(f, b"Hello, this is a new file on disk\r\n")?;
+    volume_mgr.close_file(f)?;
+    volume_mgr.close_dir(root_dir)?;
+    Ok(())
+}
+
+// ****************************************************************************
+//
+// End Of File
+//
+// ****************************************************************************

examples/create_test.rs

@@ -0,0 +1,51 @@
+//! Delete File Example.
+//!
+//! ```bash
+//! $ cargo run --example delete_file -- ./disk.img
+//! $ cargo run --example delete_file -- /dev/mmcblk0
+//! ```
+//!
+//! NOTE: THIS EXAMPLE DELETES A FILE CALLED README.TXT. IF YOU DO NOT WANT THAT
+//! FILE DELETED FROM YOUR DISK IMAGE, DO NOT RUN THIS EXAMPLE.
+//!
+//! If you pass a block device it should be unmounted. No testing has been
+//! performed with Windows raw block devices - please report back if you try
+//! this! There is a gzipped example disk image which you can gunzip and test
+//! with if you don't have a suitable block device.
+//!
+//! ```bash
+//! zcat ./tests/disk.img.gz > ./disk.img
+//! $ cargo run --example delete_file -- ./disk.img
+//! ```
+
+extern crate embedded_sdmmc;
+
+mod linux;
+use linux::*;
+
+const FILE_TO_DELETE: &str = "README.TXT";
+
+use embedded_sdmmc::{Error, VolumeIdx, VolumeManager};
+
+fn main() -> Result<(), embedded_sdmmc::Error<std::io::Error>> {
+    env_logger::init();
+    let mut args = std::env::args().skip(1);
+    let filename = args.next().unwrap_or_else(|| "/dev/mmcblk0".into());
+    let print_blocks = args.find(|x| x == "-v").map(|_| true).unwrap_or(false);
+    let lbd = LinuxBlockDevice::new(filename, print_blocks).map_err(Error::DeviceError)?;
+    let mut volume_mgr: VolumeManager<LinuxBlockDevice, Clock, 8, 8, 4> =
+        VolumeManager::new_with_limits(lbd, Clock, 0xAA00_0000);
+    let volume = volume_mgr.open_volume(VolumeIdx(0))?;
+    let root_dir = volume_mgr.open_root_dir(volume)?;
+    println!("Deleting file {}...", FILE_TO_DELETE);
+    volume_mgr.delete_file_in_dir(root_dir, FILE_TO_DELETE)?;
+    println!("Deleted!");
+    volume_mgr.close_dir(root_dir)?;
+    Ok(())
+}
+
+// ****************************************************************************
+//
+// End Of File
+//
+// ****************************************************************************