From 5d79af545bfe72f455ee05e23f1dccbac1559e45 Mon Sep 17 00:00:00 2001
From: Jiahao XU <Jiahao_XU@outlook.com>
Date: Tue, 21 Jun 2022 13:38:24 +1000
Subject: [PATCH] Add doc for `Vfs`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
---
 src/drivers/vfs.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/drivers/vfs.rs b/src/drivers/vfs.rs
index 18c422de..66e4875e 100644
--- a/src/drivers/vfs.rs
+++ b/src/drivers/vfs.rs
@@ -6,6 +6,9 @@ use cargo_toml::AbstractFilesystem;
 
 use crate::helpers::PathExt;
 
+/// This type stores the filesystem structure for the crate tarball
+/// extracted in memory and can be passed to
+/// `cargo_toml::Manifest::complete_from_abstract_filesystem`.
 #[derive(Debug)]
 pub(super) struct Vfs(HashMap<Box<Path>, HashSet<Box<str>>>);