Skip to content

docs: adds same snippet of writing to files to lib.rs for crate doc #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 20, 2025
Merged

docs: adds same snippet of writing to files to lib.rs for crate doc #175

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
714d3eb
docs: adds same snippet of writing to files to `lib.rs` for crate doc
zpg6 Jan 18, 2025
8a407ea
fix: `ignore` will pass ci/cd for known-to-be pseudocode
zpg6 Jan 18, 2025
b3014cf
fix: extraneous comma
zpg6 Jan 18, 2025
a9fd5a4
Update src/lib.rs with suggestion
zpg6 Jan 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,25 @@
//! }
//! ```
//!
//! For writing files:
//!
//! ```rust
//! use embedded_sdmmc::{BlockDevice, Directory, Error, Mode, TimeSource};
//! fn write_file<D: BlockDevice, T: TimeSource, const DIRS: usize, const FILES: usize, const VOLUMES: usize>(
//! root_dir: &mut Directory<D, T, DIRS, FILES, VOLUMES>,
//! ) -> Result<(), Error<D::Error>>
//! {
//! let my_other_file = root_dir.open_file_in_dir("MY_DATA.CSV", Mode::ReadWriteCreateOrAppend)?;
//! my_other_file.write(b"Timestamp,Signal,Value\n")?;
//! my_other_file.write(b"2025-01-01T00:00:00Z,TEMP,25.0\n")?;
//! my_other_file.write(b"2025-01-01T00:00:01Z,TEMP,25.1\n")?;
//! my_other_file.write(b"2025-01-01T00:00:02Z,TEMP,25.2\n")?;
//! // Don't forget to flush the file so that the directory entry is updated
//! my_other_file.flush()?;
//! Ok(())
//! }
//! ```
//!
//! ## Features
//!
//! * `log`: Enabled by default. Generates log messages using the `log` crate.
Expand Down
Loading