Skip to content

Update guide: dx/dir-structure/guide #25

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

Closed
github-actions wants to merge 1 commit into from
Closed

Update guide: dx/dir-structure/guide #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 3 additions & 19 deletions doc/docs/content/docs/dx/dir-structure/guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,4 @@
---
title: Quick intro guide to dir-structure
full: true
---

This guide is intended to provide a comprehensive overview of the `dir-structure` crate,
which simplifies the representation and manipulation of directory structures in Rust.
It covers basic usage, advanced features, and practical examples to help you get started quickly.

Each step shows an example directory structure that the code will expect to read or write.

This guide is mostly adapted from the [introductory blog post][blog post]. The blog post discusses it in
more detail, while this guide focuses on the practical aspects of using the crate.

[blog post]: https://dnbln.dev/blog/dir-structure

<ScrollyCoding>


## !!steps Basics
Expand Down Expand Up @@ -141,7 +125,7 @@ dir.write(path)?;

Yes, you can use serde types as well. You need to tell the library what format to use for serialization and deserialization.

This is an example using JSON, but TOML, YAML, and RON are also supported.
This is an example using JSON, but TOML, YAML, and RON are also supported, behind the respective features.

<Mermaid
chart={`
Expand Down Expand Up @@ -408,6 +392,7 @@ dir.write(path)?;
## !!steps Or even large directories?

When dealing with large directories, you can use deferred (lazy) reading.
This can be achieved with `DeferredRead`.

<Mermaid
chart={`
Expand Down Expand Up @@ -479,7 +464,7 @@ dir.write(path)?;
```
## !!steps And if we want to cache the read values?

The library exposes a `DeferredReadOrOwn` type, which allows you to cache the read values.
The library also exposes a `DeferredReadOrOwn` type, which allows you to cache the read values.

<Mermaid
chart={`
Expand Down Expand Up @@ -1396,4 +1381,3 @@ assert!(v.is_dirty());

</ScrollyCoding>